From 6976123cae404bb883c8f4e05bfb6b72a1d774a4 Mon Sep 17 00:00:00 2001 From: karthik-sethuraman Date: Mon, 1 Jul 2019 11:41:20 -0400 Subject: [PATCH 1/3] Removed old OAS files in prep for 2.2-RC3 --- OAS/tapi-common@2018-12-10.yaml | 910 - OAS/tapi-connectivity@2018-12-10.yaml | 13809 ----------- OAS/tapi-dsr@2018-12-10.yaml | 17630 -------------- OAS/tapi-eth@2018-12-10.yaml | 24319 -------------------- OAS/tapi-notification@2018-12-10.yaml | 2484 -- OAS/tapi-oam@2018-12-10.yaml | 17630 -------------- OAS/tapi-odu@2018-12-10.yaml | 18648 --------------- OAS/tapi-path-computation@2018-12-10.yaml | 9391 -------- OAS/tapi-photonic-media@2018-12-10.yaml | 22097 ------------------ OAS/tapi-topology@2018-12-10.yaml | 6401 ------ OAS/tapi-virtual-network@2018-12-10.yaml | 8692 ------- 11 files changed, 142011 deletions(-) delete mode 100644 OAS/tapi-common@2018-12-10.yaml delete mode 100644 OAS/tapi-connectivity@2018-12-10.yaml delete mode 100644 OAS/tapi-dsr@2018-12-10.yaml delete mode 100644 OAS/tapi-eth@2018-12-10.yaml delete mode 100644 OAS/tapi-notification@2018-12-10.yaml delete mode 100644 OAS/tapi-oam@2018-12-10.yaml delete mode 100644 OAS/tapi-odu@2018-12-10.yaml delete mode 100644 OAS/tapi-path-computation@2018-12-10.yaml delete mode 100644 OAS/tapi-photonic-media@2018-12-10.yaml delete mode 100644 OAS/tapi-topology@2018-12-10.yaml delete mode 100644 OAS/tapi-virtual-network@2018-12-10.yaml diff --git a/OAS/tapi-common@2018-12-10.yaml b/OAS/tapi-common@2018-12-10.yaml deleted file mode 100644 index 0c9b5926..00000000 --- a/OAS/tapi-common@2018-12-10.yaml +++ /dev/null @@ -1,910 +0,0 @@ ---- -swagger: "2.0" -info: - description: "tapi-common API generated from yang definitions" - version: "1.0" - title: "tapi-common API" -host: "localhost:1234" -consumes: -- "application/yang-data+json" -produces: -- "application/yang-data+json" -paths: - /data/context/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.TapiContext" - parameters: [] - responses: - 200: - description: "tapi.common.TapiContext" - schema: - $ref: "#/definitions/tapi.common.TapiContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.TapiContext" - parameters: - - in: "body" - name: "tapi.common.TapiContext.body-param" - description: "tapi.common.TapiContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.TapiContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.TapiContext" - parameters: - - in: "body" - name: "tapi.common.TapiContext.body-param" - description: "tapi.common.TapiContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.TapiContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.TapiContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePoint" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/available-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/total-potential-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /operations/get-service-interface-point-details/: - post: - tags: - - "tapi-common" - parameters: - - in: "body" - name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.common.GetServiceInterfacePointDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-service-interface-point-list/: - post: - tags: - - "tapi-common" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.common.GetServiceInterfacePointList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-service-interface-point/: - post: - tags: - - "tapi-common" - parameters: - - in: "body" - name: "tapi.common.updateserviceinterfacepoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.common.updateserviceinterfacepoint.Input" - responses: - 201: - description: "No response" - 400: - description: "Internal error" -definitions: - tapi.common.AdminStatePac: - type: "object" - properties: - operational-state: - description: "none" - $ref: "#/definitions/tapi.common.OperationalState" - lifecycle-state: - description: "none" - $ref: "#/definitions/tapi.common.LifecycleState" - administrative-state: - description: "none" - $ref: "#/definitions/tapi.common.AdministrativeState" - tapi.common.AdministrativeState: - type: "string" - enum: - - "LOCKED" - - "UNLOCKED" - tapi.common.BandwidthProfile: - type: "object" - properties: - committed-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - coupling-flag: - type: "boolean" - description: "none" - default: false - bw-profile-type: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfileType" - peak-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - committed-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - peak-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - color-aware: - type: "boolean" - description: "none" - default: false - tapi.common.BandwidthProfileType: - type: "string" - enum: - - "MEF_10.x" - - "RFC_2697" - - "RFC_2698" - - "RFC_4115" - tapi.common.Capacity: - type: "object" - properties: - bandwidth-profile: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfile" - total-size: - description: "Total capacity of the TopologicalEntity in MB/s. In case of\ - \ bandwidthProfile, this is expected to same as the committedInformationRate." - $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.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.NameAndValue: - type: "object" - properties: - value-name: - type: "string" - description: "The name of the value. The value need not have a name." - value: - type: "string" - description: "The value" - tapi.common.OperationalState: - type: "string" - enum: - - "DISABLED" - - "ENABLED" - tapi.common.ServiceInterfacePoint: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - supported-layer-protocol-qualifier: - type: "array" - description: "none" - items: - type: "string" - layer-protocol-name: - description: "Usage of layerProtocolName [>1] in the ServiceInterfacePoint\ - \ should be considered experimental" - $ref: "#/definitions/tapi.common.LayerProtocolName" - description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ - \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ - \ circuit and packet forms." - tapi.common.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.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" diff --git a/OAS/tapi-connectivity@2018-12-10.yaml b/OAS/tapi-connectivity@2018-12-10.yaml deleted file mode 100644 index 0f224a67..00000000 --- a/OAS/tapi-connectivity@2018-12-10.yaml +++ /dev/null @@ -1,13809 +0,0 @@ ---- -swagger: "2.0" -info: - description: "tapi-path-computation,tapi-connectivity,tapi-notification,tapi-topology,tapi-common\ - \ API generated from yang definitions" - version: "1.0" - title: "tapi-path-computation,tapi-connectivity,tapi-notification,tapi-topology,tapi-common\ - \ API" -host: "localhost:1234" -consumes: -- "application/yang-data+json" -produces: -- "application/yang-data+json" -paths: - /data/context/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Context" - parameters: [] - responses: - 200: - description: "tapi.common.Context" - schema: - $ref: "#/definitions/tapi.common.Context" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.Context" - parameters: - - in: "body" - name: "tapi.common.Context.body-param" - description: "tapi.common.Context to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.Context" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.Context" - parameters: - - in: "body" - name: "tapi.common.Context.body-param" - description: "tapi.common.Context to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.Context" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.Context" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityContext" - parameters: [] - responses: - 200: - description: "tapi.connectivity.ConnectivityContext" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityContext" - 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.ConnectivityContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityContext" - 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.ConnectivityContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connection={uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.Connection" - parameters: - - name: "uuid" - in: "path" - description: "Id of connection" - required: true - type: "string" - responses: - 200: - description: "tapi.connectivity.Connection" - schema: - $ref: "#/definitions/tapi.connectivity.Connection" - 400: - description: "Internal error" - ? /data/context/connectivity-context/connection={uuid}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" - 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.ConnectionEndPointRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/lower-connection={connection-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionRef" - 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.ConnectionRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - 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.NameAndValue" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/route={local-id}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.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.Route" - schema: - $ref: "#/definitions/tapi.connectivity.Route" - 400: - description: "Internal error" - ? /data/context/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" - description: "returns tapi.connectivity.ConnectionEndPointRef" - 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.ConnectionEndPointRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/route={local-id}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - 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.NameAndValue" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/supported-client-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" - 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.LinkRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.SwitchControl" - 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.SwitchControl" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - 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.NameAndValue" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/resilience-type/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of connection" - required: true - type: "string" - - name: "switch-control-uuid" - in: "path" - description: "Id of switch-control" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" - ? /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/sub-switch-control={connection-uuid},{sub-switch-control-switch-control-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.SwitchControlRef" - 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.SwitchControlRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/switch={local-id}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.Switch" - 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.Switch" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/switch={local-id}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - 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.NameAndValue" - 400: - description: "Internal error" - ? /data/context/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" - description: "returns tapi.connectivity.ConnectionEndPointRef" - 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.ConnectionEndPointRef" - 400: - description: "Internal error" - ? /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/switch={local-id}/selected-route={connection-uuid},{route-local-id}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.RouteRef" - 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.RouteRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityService" - 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.ConnectivityService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityService" - 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.ConnectivityService" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityService" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityService.body-param" - description: "tapi.connectivity.ConnectivityService to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityService" - 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.ConnectivityService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityService" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/avoid-topology={topology-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of avoid-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/connection={connection-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionRef" - 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.ConnectionRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/coroute-inclusion/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceRef" - 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.ConnectivityServiceRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceRef" - 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.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/cost-characteristic/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.CostCharacteristic" - 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.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/diversity-exclusion/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" - 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.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/diversity-exclusion={connectivity-service-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "connectivity-service-uuid" - in: "path" - description: "Id of diversity-exclusion" - required: true - type: "string" - responses: - 200: - description: "tapi.connectivity.ConnectivityServiceRef" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "connectivity-service-uuid" - in: "path" - description: "Id of diversity-exclusion" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceRef" - 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.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "connectivity-service-uuid" - in: "path" - description: "Id of diversity-exclusion" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPoint to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceEndPoint" - 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.ConnectivityServiceEndPoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPoint to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceEndPoint" - 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.ConnectivityServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.Capacity" - 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.Capacity" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.Capacity" - 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.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.BandwidthProfile" - 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.BandwidthProfile" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/total-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.connectivity.ConnectionEndPointRef" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - 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.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/service-interface-point/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.ServiceInterfacePointRef" - 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.ServiceInterfacePointRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.ServiceInterfacePointRef" - 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.ServiceInterfacePointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.ServiceInterfacePointRef" - 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.ServiceInterfacePointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-path={path-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of exclude-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-path={path-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of include-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-topology={topology-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/latency-characteristic/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.LatencyCharacteristic" - 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.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/name/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.Capacity" - 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.Capacity" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.Capacity" - 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.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.BandwidthProfile" - 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.BandwidthProfile" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/total-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/resilience-type/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.ResilienceType" - 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.ResilienceType" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.ResilienceType" - parameters: - - name: "uuid" - 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.ResilienceType" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/risk-diversity-characteristic/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/risk-diversity-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/schedule/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.TimeRange" - 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.TimeRange" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.TimeRange" - 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.TimeRange" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.TimeRange" - parameters: - - name: "uuid" - 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.TimeRange" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.TimeRange" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationContext" - parameters: [] - responses: - 200: - description: "tapi.notification.NotificationContext" - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationContext" - parameters: - - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationContext" - parameters: - - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription/: - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" - parameters: - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NotificationSubscriptionService" - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NotificationChannel" - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.Notification" - schema: - $ref: "#/definitions/tapi.notification.Notification" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of additional-info" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of changed-attributes" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NameAndValueChange" - schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of target-object-name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/tca-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.SubscriptionFilter" - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notification={uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.Notification" - schema: - $ref: "#/definitions/tapi.notification.Notification" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/additional-info={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of additional-info" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of changed-attributes" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NameAndValueChange" - schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of target-object-name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/tca-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" - /data/context/path-computation-context/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathComputationContext" - parameters: [] - responses: - 200: - description: "tapi.path.computation.PathComputationContext" - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationContext" - parameters: - - in: "body" - name: "tapi.path.computation.PathComputationContext.body-param" - description: "tapi.path.computation.PathComputationContext to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathComputationContext" - parameters: - - in: "body" - name: "tapi.path.computation.PathComputationContext.body-param" - description: "tapi.path.computation.PathComputationContext to be added or\ - \ updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathComputationContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationService" - parameters: - - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathComputationService" - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - 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.PathComputationService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - 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.PathServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathServiceEndPoint" - schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.Capacity" - 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.Capacity" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.Capacity" - 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.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.Capacity" - 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.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.BandwidthProfile" - 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.BandwidthProfile" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/total-size/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/service-interface-point/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathObjectiveFunction" - schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathObjectiveFunction.body-param" - description: "tapi.path.computation.PathObjectiveFunction to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathObjectiveFunction.body-param" - description: "tapi.path.computation.PathObjectiveFunction to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathOptimizationConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathOptimizationConstraint.body-param" - description: "tapi.path.computation.PathOptimizationConstraint to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathOptimizationConstraint.body-param" - description: "tapi.path.computation.PathOptimizationConstraint to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.RoutingConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.RoutingConstraint.body-param" - description: "tapi.path.computation.RoutingConstraint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.RoutingConstraint.body-param" - description: "tapi.path.computation.RoutingConstraint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.TopologyConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.TopologyConstraint.body-param" - description: "tapi.path.computation.TopologyConstraint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.TopologyConstraint.body-param" - description: "tapi.path.computation.TopologyConstraint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/avoid-topology={topology-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of avoid-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of exclude-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of include-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-topology={topology-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.Path" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.Path" - schema: - $ref: "#/definitions/tapi.path.computation.Path" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.RoutingConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/service-interface-point/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePoint" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/available-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/total-potential-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyContext" - parameters: [] - responses: - 200: - description: "tapi.topology.TopologyContext" - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-topology" - description: "creates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.context.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-topology" - description: "creates or updates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.context.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-topology" - description: "removes tapi.topology.TopologyContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/topology-context/nw-topology-service/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NetworkTopologyService" - parameters: [] - responses: - 200: - description: "tapi.topology.NetworkTopologyService" - schema: - $ref: "#/definitions/tapi.topology.NetworkTopologyService" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "topology-uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Topology" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Topology" - schema: - $ref: "#/definitions/tapi.topology.Topology" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Link" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Link" - schema: - $ref: "#/definitions/tapi.topology.Link" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/resilience-type/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ValidationMechanism" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "validation-mechanism" - in: "path" - description: "Id of validation-mechanism" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ValidationMechanism" - schema: - $ref: "#/definitions/tapi.topology.ValidationMechanism" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.topology.Node" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.topology.Node" - schema: - $ref: "#/definitions/tapi.topology.topology.Node" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroup" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroup" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-rule-group-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroupRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.InterRuleGroup" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.InterRuleGroup" - schema: - $ref: "#/definitions/tapi.topology.InterRuleGroup" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-rule-group-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroupRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Rule" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Rule" - schema: - $ref: "#/definitions/tapi.topology.Rule" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Rule" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Rule" - schema: - $ref: "#/definitions/tapi.topology.Rule" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.node.OwnedNodeEdgePoint" - parameters: - - name: "uuid" - 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.OwnedNodeEdgePoint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.CepList" - parameters: - - name: "uuid" - 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.CepList" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPoint" - parameters: - - name: "uuid" - 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.ConnectionEndPoint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/aggregated-connection-end-point={topology-uuid},{aggregated-connection-end-point-node-uuid},{node-edge-point-uuid},{aggregated-connection-end-point-connection-end-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" - parameters: - - name: "uuid" - 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.ConnectionEndPointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/client-node-edge-point={topology-uuid},{client-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - 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.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/name={value-name}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/parent-node-edge-point/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "service-interface-point-uuid" - in: "path" - description: "Id of mapped-service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /operations/compute-p-2-p-path/: - post: - tags: - - "tapi-path-computation" - parameters: - - in: "body" - name: "tapi.path.computation.computep2ppath.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.path.computation.computep2ppath.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.path.computation.ComputeP2PPath" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-connectivity-service/: - post: - tags: - - "tapi-connectivity" - parameters: - - in: "body" - name: "tapi.connectivity.createconnectivityservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.connectivity.createconnectivityservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.connectivity.CreateConnectivityService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-notification-subscription-service/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.CreateNotificationSubscriptionService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/delete-connectivity-service/: - post: - tags: - - "tapi-connectivity" - 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/delete-notification-subscription-service/: - post: - tags: - - "tapi-notification" - 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/delete-p-2-p-path/: - post: - tags: - - "tapi-path-computation" - 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/get-connection-details/: - post: - tags: - - "tapi-connectivity" - 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/get-connection-end-point-details/: - post: - tags: - - "tapi-connectivity" - 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/get-connectivity-service-details/: - post: - tags: - - "tapi-connectivity" - 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/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/get-link-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.getlinkdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.getlinkdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetLinkDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-node-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.getnodedetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.getnodedetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetNodeDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-node-edge-point-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.getnodeedgepointdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetNodeEdgePointDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-list/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.getnotificationlist.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.getnotificationlist.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-subscription-service-details/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-subscription-service-list/: - post: - tags: - - "tapi-notification" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-service-interface-point-details/: - post: - tags: - - "tapi-common" - parameters: - - in: "body" - name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.common.GetServiceInterfacePointDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-service-interface-point-list/: - post: - tags: - - "tapi-common" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.common.GetServiceInterfacePointList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-supported-notification-types/: - post: - tags: - - "tapi-notification" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetSupportedNotificationTypes" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-topology-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.gettopologydetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.gettopologydetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetTopologyDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-topology-list/: - post: - tags: - - "tapi-topology" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetTopologyList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/optimize-p-2-p-path/: - post: - tags: - - "tapi-path-computation" - 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/update-connectivity-service/: - post: - tags: - - "tapi-connectivity" - 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/update-notification-subscription-service/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.UpdateNotificationSubscriptionService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-service-interface-point/: - post: - tags: - - "tapi-common" - parameters: - - in: "body" - name: "tapi.common.updateserviceinterfacepoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.common.updateserviceinterfacepoint.Input" - responses: - 201: - description: "No response" - 400: - description: "Internal error" -definitions: - tapi.common.AdminStatePac: - type: "object" - properties: - operational-state: - description: "none" - $ref: "#/definitions/tapi.common.OperationalState" - lifecycle-state: - description: "none" - $ref: "#/definitions/tapi.common.LifecycleState" - administrative-state: - description: "none" - $ref: "#/definitions/tapi.common.AdministrativeState" - tapi.common.AdministrativeState: - type: "string" - enum: - - "LOCKED" - - "UNLOCKED" - tapi.common.BandwidthProfile: - type: "object" - properties: - committed-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - coupling-flag: - type: "boolean" - description: "none" - default: false - bw-profile-type: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfileType" - peak-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - committed-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - peak-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - color-aware: - type: "boolean" - description: "none" - default: false - tapi.common.BandwidthProfileType: - type: "string" - enum: - - "MEF_10.x" - - "RFC_2697" - - "RFC_2698" - - "RFC_4115" - tapi.common.Capacity: - type: "object" - properties: - bandwidth-profile: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfile" - total-size: - description: "Total capacity of the TopologicalEntity in MB/s. In case of\ - \ bandwidthProfile, this is expected to same as the committedInformationRate." - $ref: "#/definitions/tapi.common.CapacityValue" - tapi.common.CapacityPac: - type: "object" - properties: - available-capacity: - description: "Capacity available to be assigned." - $ref: "#/definitions/tapi.common.Capacity" - total-potential-capacity: - description: "An optimistic view of the capacity of the TopologicalEntity\ - \ assuming that any shared capacity is available to be taken." - $ref: "#/definitions/tapi.common.Capacity" - tapi.common.CapacityUnit: - type: "string" - enum: - - "TB" - - "TBPS" - - "GB" - - "GBPS" - - "MB" - - "MBPS" - - "KB" - - "KBPS" - - "GHz" - - "MHz" - tapi.common.CapacityValue: - type: "object" - properties: - value: - type: "integer" - format: "int32" - description: "none" - unit: - description: "none" - $ref: "#/definitions/tapi.common.CapacityUnit" - tapi.common.Context: - allOf: - - $ref: "#/definitions/tapi.common.TapiContext" - - $ref: "#/definitions/tapi.connectivity.ContextAugmentation3" - - $ref: "#/definitions/tapi.notification.ContextAugmentation1" - - $ref: "#/definitions/tapi.path.computation.ContextAugmentation2" - - $ref: "#/definitions/tapi.topology.ContextAugmentation4" - 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.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" - description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ - \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ - \ circuit and packet forms." - tapi.common.ServiceInterfacePointRef: - type: "object" - properties: - service-interface-point-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-common:service-interface-point/tapi-common:uuid" - tapi.common.TapiContext: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - service-interface-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - description: "The Network Control Domain (NCD) object class represents the scope\ - \ of control that a particular SDN controller has with respect to a particular\ - \ network, (i.e., encompassing a designated set of interconnected (virtual)\ - \ network elements)." - tapi.common.TerminationDirection: - type: "string" - enum: - - "BIDIRECTIONAL" - - "SINK" - - "SOURCE" - - "UNDEFINED_OR_UNKNOWN" - tapi.common.TerminationPac: - type: "object" - properties: - termination-direction: - description: "The overall directionality of the LP. \r\n \ - \ - A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ - \ - A SINK LP can only contain elements with SINK flows\ - \ or CONTRA_DIRECTION_SOURCE flows\r\n - A SOURCE LP\ - \ can only contain SOURCE flows or CONTRA_DIRECTION_SINK flows" - $ref: "#/definitions/tapi.common.TerminationDirection" - termination-state: - description: "Indicates whether the layer is terminated and if so how." - $ref: "#/definitions/tapi.common.TerminationState" - tapi.common.TerminationState: - type: "string" - enum: - - "LP_CAN_NEVER_TERMINATE" - - "LT_NOT_TERMINATED" - - "TERMINATED_SERVER_TO_CLIENT_FLOW" - - "TERMINATED_CLIENT_TO_SERVER_FLOW" - - "TERMINATED_BIDIRECTIONAL" - - "LT_PERMENANTLY_TERMINATED" - - "TERMINATION_STATE_UNKNOWN" - tapi.common.TimeRange: - type: "object" - properties: - end-time: - type: "string" - description: "none" - start-time: - type: "string" - description: "none" - tapi.common.getserviceinterfacepointdetails.Input: - type: "object" - properties: - 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.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" - 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" - 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.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.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" - 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" - coroute-inclusion: - description: "none" - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" - tapi.connectivity.ConnectivityContext: - type: "object" - properties: - connectivity-service: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ConnectivityService" - connection: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.Connection" - tapi.connectivity.ConnectivityService: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" - - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - - type: "object" - properties: - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" - connection: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ConnectionRef" - description: "The ForwardingConstruct (FC) object class models enabled potential\ - \ for forwarding between two or more LTPs and like the LTP supports any transport\ - \ protocol including all circuit and packet forms.\r\n At the\ - \ lowest level of recursion, a FC represents a cross-connection within an\ - \ NE." - tapi.connectivity.ConnectivityServiceEndPoint: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $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" - 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" - 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.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.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.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" - description: "The FC Route (FcRoute) object class models the individual routes\ - \ of an FC. \r\n The route of an FC object is represented by\ - \ a list of FCs at a lower level. \r\n Note that depending\ - \ on the service supported by an FC, an the FC can have multiple routes." - 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.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.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.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.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.NotificationContext: - type: "object" - properties: - notif-subscription: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - notification: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.Notification" - tapi.notification.NotificationSubscriptionService: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - notification: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.Notification" - notification-channel: - description: "none" - $ref: "#/definitions/tapi.notification.NotificationChannel" - subscription-state: - description: "none" - $ref: "#/definitions/tapi.notification.SubscriptionState" - supported-object-types: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.ObjectType" - supported-notification-types: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.NotificationType" - subscription-filter: - description: "none" - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - description: "none" - tapi.notification.NotificationType: - type: "string" - enum: - - "OBJECT_CREATION" - - "OBJECT_DELETION" - - "ATTRIBUTE_VALUE_CHANGE" - - "ALARM_EVENT" - - "THRESHOLD_CROSSING_ALERT" - tapi.notification.ObjectType: - type: "string" - enum: - - "TOPOLOGY" - - "NODE" - - "LINK" - - "CONNECTION" - - "PATH" - - "CONNECTIVITY_SERVICE" - - "VIRTUAL_NETWORK_SERVICE" - - "PATH_COMPUTATION_SERVICE" - - "NODE_EDGE_POINT" - - "SERVICE_INTERFACE_POINT" - - "CONNECTION_END_POINT" - - "MAINTENANCE_ENTITY_GROUP" - - "MAINTENANCE_ENTITY" - - "MEG_END_POINT" - - "MEG_INTERMEDIATE_POINT" - - "SWITCH_CONTROL" - - "SWITCH" - - "ROUTE" - - "NODE_RULE_GROUP" - - "INTER_RULE_GROUP" - - "RULE" - - "OAM_JOB" - tapi.notification.PerceivedSeverityType: - type: "string" - enum: - - "CRITICAL" - - "MAJOR" - - "MINOR" - - "WARNING" - - "CLEARED" - tapi.notification.PerceivedTcaSeverity: - type: "string" - enum: - - "WARNING" - - "CLEAR" - tapi.notification.ServiceAffecting: - type: "string" - enum: - - "SERVICE_AFFECTING" - - "NOT_SERVICE_AFFECTING" - - "UNKNOWN" - 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.SubscriptionState: - type: "string" - enum: - - "SUSPENDED" - - "ACTIVE" - tapi.notification.TcaInfo: - type: "object" - properties: - threshold-crossing: - description: "none" - $ref: "#/definitions/tapi.notification.ThresholdCrossingType" - threshold-parameter: - type: "string" - description: "none" - is-transient: - type: "boolean" - description: "none" - default: false - threshold-value: - type: "integer" - format: "int32" - description: "none" - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedTcaSeverity" - suspect-interval-flag: - type: "boolean" - description: "none" - default: false - measurement-interval: - type: "string" - description: "none" - tapi.notification.ThresholdCrossingType: - type: "string" - enum: - - "THRESHOLD_ABOVE" - - "THRESHOLD_BELOW" - - "CLEARED" - tapi.notification.UpdateNotificationSubscriptionService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Output" - tapi.notification.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.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.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.PathOptimizationConstraint: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - traffic-interruption: - description: "none" - $ref: "#/definitions/tapi.common.DirectiveValue" - description: "none" - 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.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.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 - 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" - 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.TopologyConstraint: - type: "object" - properties: - include-node: - type: "array" - description: "This is a loose constraint - that is it is unordered and could\ - \ be a partial list" - items: - $ref: "#/definitions/tapi.topology.NodeRef" - exclude-link: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.LinkRef" - avoid-topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - exclude-path: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.path.computation.PathRef" - include-link: - type: "array" - description: "This is a loose constraint - that is it is unordered and could\ - \ be a partial list " - items: - $ref: "#/definitions/tapi.topology.LinkRef" - preferred-transport-layer: - type: "array" - description: "soft constraint requested by client to indicate the layer(s)\ - \ of transport connection that it prefers to carry the service. This could\ - \ be same as the service layer or one of the supported server layers" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - exclude-node: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRef" - include-topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - include-path: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.path.computation.PathRef" - 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.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.ForwardingRule: - type: "string" - enum: - - "MAY_FORWARD_ACROSS_GROUP" - - "MUST_FORWARD_ACROSS_GROUP" - - "CANNOT_FORWARD_ACROSS_GROUP" - - "NO_STATEMENT_ON_FORWARDING" - tapi.topology.GetLinkDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.getlinkdetails.Output" - tapi.topology.GetNodeDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.getnodedetails.Output" - tapi.topology.GetNodeEdgePointDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Output" - tapi.topology.GetTopologyDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.gettopologydetails.Output" - tapi.topology.GetTopologyList: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.gettopologylist.Output" - tapi.topology.InterRuleGroup: - allOf: - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.RiskParameterPac" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - type: "object" - properties: - associated-node-rule-group: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - rule: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Rule" - description: "none" - tapi.topology.LatencyCharacteristic: - type: "object" - properties: - traffic-property-name: - type: "string" - description: "The identifier of the specific traffic property to which the\ - \ queuing latency applies." - jitter-characteristic: - type: "string" - description: "High frequency deviation from true periodicity of a signal and\ - \ therefore a small high rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." - fixed-latency-characteristic: - type: "string" - description: "A TopologicalEntity suffers delay caused by the realization\ - \ of the servers (e.g. distance related; FEC encoding etc.) along with some\ - \ client specific processing. This is the total average latency effect of\ - \ the TopologicalEntity" - wander-characteristic: - type: "string" - description: "Low frequency deviation from true periodicity of a signal and\ - \ therefore a small low rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." - queing-latency-characteristic: - type: "string" - description: "The specific queuing latency for the traffic property." - tapi.topology.LayerProtocolTransitionPac: - type: "object" - properties: - transitioned-layer-protocol-name: - type: "array" - description: "Provides the ordered structure of layer protocol transitions\ - \ encapsulated in the TopologicalEntity. The ordering relates to the LinkPort\ - \ role." - items: - type: "string" - tapi.topology.Link: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.LayerProtocolTransitionPac" - - $ref: "#/definitions/tapi.topology.RiskParameterPac" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - $ref: "#/definitions/tapi.topology.ValidationPac" - - type: "object" - properties: - layer-protocol-name: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - 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.NetworkTopologyService: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - description: "none" - tapi.topology.Node: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - type: "object" - properties: - layer-protocol-name: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - encap-topology: - description: "none" - $ref: "#/definitions/tapi.topology.TopologyRef" - 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.NodeRef: - allOf: - - $ref: "#/definitions/tapi.topology.TopologyRef" - - type: "object" - properties: - node-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:uuid" - description: "none" - tapi.topology.NodeRuleGroup: - allOf: - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.RiskParameterPac" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - type: "object" - properties: - inter-rule-group: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.InterRuleGroup" - rule: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Rule" - composed-rule-group: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - node-edge-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - description: "none" - tapi.topology.NodeRuleGroupRef: - allOf: - - $ref: "#/definitions/tapi.topology.NodeRef" - - type: "object" - properties: - node-rule-group-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-rule-group/tapi-topology:uuid" - description: "none" - tapi.topology.ProtectionType: - type: "string" - enum: - - "NO_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" - 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.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.RiskParameterPac: - type: "object" - properties: - risk-characteristic: - type: "array" - description: "A list of risk characteristics for consideration in an analysis\ - \ of shared risk. Each element of the list represents a specific risk consideration." - items: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - tapi.topology.Rule: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - override-priority: - type: "integer" - format: "int32" - description: "none" - forwarding-rule: - description: "none" - $ref: "#/definitions/tapi.topology.ForwardingRule" - rule-type: - description: "none" - $ref: "#/definitions/tapi.topology.RuleType" - description: "none" - tapi.topology.RuleType: - type: "string" - enum: - - "FORWARDING" - - "CAPACITY" - - "COST" - - "TIMING" - - "RISK" - - "GROUPING" - tapi.topology.Topology: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - layer-protocol-name: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - link: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Link" - node: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Node" - description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ - \ topological component which is used to effect forwarding of transport characteristic\ - \ information and offers the potential to enable forwarding. \r\n \ - \ At the lowest level of recursion, an FD (within a network element\ - \ (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ - \ multiple switch matrices (FDs). " - tapi.topology.TopologyContext: - type: "object" - properties: - nw-topology-service: - description: "none" - $ref: "#/definitions/tapi.topology.NetworkTopologyService" - topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Topology" - tapi.topology.TopologyRef: - type: "object" - properties: - topology-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:uuid" - tapi.topology.TransferCostPac: - type: "object" - properties: - cost-characteristic: - type: "array" - description: "The list of costs where each cost relates to some aspect of\ - \ the TopologicalEntity." - items: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - tapi.topology.TransferIntegrityPac: - type: "object" - properties: - error-characteristic: - type: "string" - description: "Describes the degree to which the signal propagated can be errored.\ - \ \r\n Applies to TDM systems as the errored signal will\ - \ be propagated and not packet as errored packets will be discarded." - unavailable-time-characteristic: - type: "string" - description: "Describes the duration for which there may be no valid signal\ - \ propagated." - server-integrity-process-characteristic: - type: "string" - description: "Describes the effect of any server integrity enhancement process\ - \ on the characteristics of the TopologicalEntity." - delivery-order-characteristic: - type: "string" - description: "Describes the degree to which packets will be delivered out\ - \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ - \ maintain strict order." - repeat-delivery-characteristic: - type: "string" - description: "Primarily applies to packet systems where a packet may be delivered\ - \ more than once (in fault recovery for example). \r\n \ - \ It can also apply to TDM where several frames may be received twice\ - \ due to switching in a system with a large differential propagation delay." - loss-characteristic: - type: "string" - description: "Describes the acceptable characteristic of lost packets where\ - \ loss may result from discard due to errors or overflow.\r\n \ - \ Applies to packet systems and not TDM (as for TDM errored signals\ - \ are propagated unless grossly errored and overflow/underflow turns into\ - \ timing slips)." - tapi.topology.TransferTimingPac: - type: "object" - properties: - latency-characteristic: - type: "array" - description: "The effect on the latency of a queuing process. This only has\ - \ significant effect for packet based systems and has a complex characteristic." - items: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - tapi.topology.ValidationMechanism: - type: "object" - properties: - layer-protocol-adjacency-validated: - type: "string" - description: "State of validatiion" - validation-mechanism: - type: "string" - description: "Name of mechanism used to validate adjacency" - validation-robustness: - type: "string" - description: "Quality of validation (i.e. how likely is the stated validation\ - \ to be invalid)" - tapi.topology.ValidationPac: - type: "object" - properties: - validation-mechanism: - type: "array" - description: "Provides details of the specific validation mechanism(s) used\ - \ to confirm the presence of an intended topologicalEntity." - items: - $ref: "#/definitions/tapi.topology.ValidationMechanism" - tapi.topology.getlinkdetails.Input: - type: "object" - properties: - link-id-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.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" diff --git a/OAS/tapi-dsr@2018-12-10.yaml b/OAS/tapi-dsr@2018-12-10.yaml deleted file mode 100644 index 7e0c3441..00000000 --- a/OAS/tapi-dsr@2018-12-10.yaml +++ /dev/null @@ -1,17630 +0,0 @@ ---- -swagger: "2.0" -info: - description: "tapi-oam,tapi-path-computation,tapi-connectivity,tapi-dsr,tapi-notification,tapi-topology,tapi-common\ - \ API generated from yang definitions" - version: "1.0" - title: "tapi-oam,tapi-path-computation,tapi-connectivity,tapi-dsr,tapi-notification,tapi-topology,tapi-common\ - \ API" -host: "localhost:1234" -consumes: -- "application/yang-data+json" -produces: -- "application/yang-data+json" -paths: - /data/context/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Context" - parameters: [] - responses: - 200: - description: "tapi.common.Context" - schema: - $ref: "#/definitions/tapi.common.Context" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.Context" - parameters: - - in: "body" - name: "tapi.common.Context.body-param" - description: "tapi.common.Context to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.Context" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.Context" - parameters: - - in: "body" - name: "tapi.common.Context.body-param" - description: "tapi.common.Context to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.Context" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.Context" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityContext" - parameters: [] - responses: - 200: - description: "tapi.connectivity.ConnectivityContext" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityContext" - 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.ConnectivityContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityContext" - 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.ConnectivityContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connection={uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.Connection" - parameters: - - name: "uuid" - in: "path" - description: "Id of connection" - required: true - type: "string" - responses: - 200: - description: "tapi.connectivity.Connection" - schema: - $ref: "#/definitions/tapi.connectivity.Connection" - 400: - description: "Internal error" - ? /data/context/connectivity-context/connection={uuid}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" - 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.ConnectionEndPointRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/lower-connection={connection-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionRef" - 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.ConnectionRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - 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.NameAndValue" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/route={local-id}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.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.Route" - schema: - $ref: "#/definitions/tapi.connectivity.Route" - 400: - description: "Internal error" - ? /data/context/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" - description: "returns tapi.connectivity.ConnectionEndPointRef" - 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.ConnectionEndPointRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/route={local-id}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - 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.NameAndValue" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/supported-client-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" - 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.LinkRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.SwitchControl" - 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.SwitchControl" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - 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.NameAndValue" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/resilience-type/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of connection" - required: true - type: "string" - - name: "switch-control-uuid" - in: "path" - description: "Id of switch-control" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" - ? /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/sub-switch-control={connection-uuid},{sub-switch-control-switch-control-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.SwitchControlRef" - 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.SwitchControlRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/switch={local-id}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.Switch" - 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.Switch" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/switch={local-id}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - 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.NameAndValue" - 400: - description: "Internal error" - ? /data/context/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" - description: "returns tapi.connectivity.ConnectionEndPointRef" - 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.ConnectionEndPointRef" - 400: - description: "Internal error" - ? /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/switch={local-id}/selected-route={connection-uuid},{route-local-id}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.RouteRef" - 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.RouteRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityService" - 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.ConnectivityService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityService" - 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.ConnectivityService" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityService" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityService.body-param" - description: "tapi.connectivity.ConnectivityService to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityService" - 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.ConnectivityService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityService" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/avoid-topology={topology-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of avoid-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/connection={connection-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionRef" - 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.ConnectionRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/coroute-inclusion/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceRef" - 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.ConnectivityServiceRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceRef" - 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.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/cost-characteristic/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.CostCharacteristic" - 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.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/diversity-exclusion/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" - 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.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/diversity-exclusion={connectivity-service-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "connectivity-service-uuid" - in: "path" - description: "Id of diversity-exclusion" - required: true - type: "string" - responses: - 200: - description: "tapi.connectivity.ConnectivityServiceRef" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "connectivity-service-uuid" - in: "path" - description: "Id of diversity-exclusion" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceRef" - 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.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "connectivity-service-uuid" - in: "path" - description: "Id of diversity-exclusion" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPoint to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceEndPoint" - 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.ConnectivityServiceEndPoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPoint to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceEndPoint" - 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.ConnectivityServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.Capacity" - 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.Capacity" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.Capacity" - 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.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.BandwidthProfile" - 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.BandwidthProfile" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/total-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.connectivity.ConnectionEndPointRef" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - 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.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/service-interface-point/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.ServiceInterfacePointRef" - 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.ServiceInterfacePointRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.ServiceInterfacePointRef" - 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.ServiceInterfacePointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.ServiceInterfacePointRef" - 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.ServiceInterfacePointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-path={path-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of exclude-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-path={path-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of include-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-topology={topology-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/latency-characteristic/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.LatencyCharacteristic" - 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.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/name/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.Capacity" - 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.Capacity" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.Capacity" - 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.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.BandwidthProfile" - 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.BandwidthProfile" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/total-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/resilience-type/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.ResilienceType" - 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.ResilienceType" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.ResilienceType" - parameters: - - name: "uuid" - 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.ResilienceType" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/risk-diversity-characteristic/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/risk-diversity-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/schedule/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.TimeRange" - 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.TimeRange" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.TimeRange" - 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.TimeRange" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.TimeRange" - parameters: - - name: "uuid" - 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.TimeRange" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.TimeRange" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationContext" - parameters: [] - responses: - 200: - description: "tapi.notification.NotificationContext" - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationContext" - parameters: - - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationContext" - parameters: - - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription/: - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" - parameters: - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NotificationSubscriptionService" - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NotificationChannel" - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.Notification" - schema: - $ref: "#/definitions/tapi.notification.Notification" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of additional-info" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of changed-attributes" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NameAndValueChange" - schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of target-object-name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/tca-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.SubscriptionFilter" - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notification={uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.Notification" - schema: - $ref: "#/definitions/tapi.notification.Notification" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/additional-info={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of additional-info" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of changed-attributes" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NameAndValueChange" - schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of target-object-name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/tca-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" - /data/context/oam-context/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamContext" - parameters: [] - responses: - 200: - description: "tapi.oam.OamContext" - schema: - $ref: "#/definitions/tapi.oam.OamContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamContext" - parameters: - - in: "body" - name: "tapi.oam.OamContext.body-param" - description: "tapi.oam.OamContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamContext" - parameters: - - in: "body" - name: "tapi.oam.OamContext.body-param" - description: "tapi.oam.OamContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/meg={uuid}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.Meg" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.Meg" - schema: - $ref: "#/definitions/tapi.oam.Meg" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.Mep" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.Mep" - schema: - $ref: "#/definitions/tapi.oam.Mep" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.Mip" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.Mip" - schema: - $ref: "#/definitions/tapi.oam.Mip" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/oam-context/oam-job/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamJob" - parameters: - - in: "body" - name: "tapi.oam.OamJob.body-param" - description: "tapi.oam.OamJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamJob" - schema: - $ref: "#/definitions/tapi.oam.OamJob" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamJob.body-param" - description: "tapi.oam.OamJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamJob.body-param" - description: "tapi.oam.OamJob to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/oam-profile/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamProfileRef" - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/oam-service-end-point/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/oam-service-end-point={oam-service-uuid},{oam-service-end-point-local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - name: "oam-service-end-point-local-id" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamServiceEndPointRef" - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - name: "oam-service-end-point-local-id" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - name: "oam-service-end-point-local-id" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - name: "oam-service-end-point-local-id" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.PmCurrentData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.PmCurrentData" - schema: - $ref: "#/definitions/tapi.oam.PmCurrentData" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/elapsed-time/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimeInterval" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimeInterval" - schema: - $ref: "#/definitions/tapi.common.TimeInterval" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/elapsed-time/period={unit}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "unit" - in: "path" - description: "Id of period" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/granularity-period/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.PmHistoryData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.PmHistoryData" - schema: - $ref: "#/definitions/tapi.oam.PmHistoryData" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/granularity-period/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/name={value-name}/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/schedule/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimeRange" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimeRange" - schema: - $ref: "#/definitions/tapi.common.TimeRange" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.TimeRange" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.TimeRange" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.TimeRange" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.TimeRange" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.TimeRange" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamProfile" - parameters: - - in: "body" - name: "tapi.oam.OamProfile.body-param" - description: "tapi.oam.OamProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamProfile" - schema: - $ref: "#/definitions/tapi.oam.OamProfile" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfile.body-param" - description: "tapi.oam.OamProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfile.body-param" - description: "tapi.oam.OamProfile to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.PmBinData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmBinData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.PmBinData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.PmBinData" - schema: - $ref: "#/definitions/tapi.oam.PmBinData" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.PmBinData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmBinData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.PmBinData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmBinData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.PmBinData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/granularity-period/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmThresholdData.body-param" - description: "tapi.oam.PmThresholdData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.PmThresholdData" - schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmThresholdData.body-param" - description: "tapi.oam.PmThresholdData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmThresholdData.body-param" - description: "tapi.oam.PmThresholdData to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/granularity-period/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamService" - parameters: - - in: "body" - name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamService" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamService" - schema: - $ref: "#/definitions/tapi.oam.OamService" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamService" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamService" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamService" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamServiceEndPoint" - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/connectivity-service-end-point/: - get: - tags: - - "tapi-oam" - description: "returns tapi.connectivity.ConnectivityServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.connectivity.ConnectivityServiceEndPointRef" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.connectivity.ConnectivityServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.connectivity.ConnectivityServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/mep/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MepRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MepRef" - schema: - $ref: "#/definitions/tapi.oam.MepRef" - 400: - description: "Internal error" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/mip/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MipRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MipRef" - schema: - $ref: "#/definitions/tapi.oam.MipRef" - 400: - description: "Internal error" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/service-interface-point/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePointRef.body-param" - description: "tapi.common.ServiceInterfacePointRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePointRef.body-param" - description: "tapi.common.ServiceInterfacePointRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/meg/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MegRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MegRef" - schema: - $ref: "#/definitions/tapi.oam.MegRef" - 400: - description: "Internal error" - /data/context/oam-context/oam-service={uuid}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/oam-profile/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamProfileRef" - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathComputationContext" - parameters: [] - responses: - 200: - description: "tapi.path.computation.PathComputationContext" - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationContext" - parameters: - - in: "body" - name: "tapi.path.computation.PathComputationContext.body-param" - description: "tapi.path.computation.PathComputationContext to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathComputationContext" - parameters: - - in: "body" - name: "tapi.path.computation.PathComputationContext.body-param" - description: "tapi.path.computation.PathComputationContext to be added or\ - \ updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathComputationContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationService" - parameters: - - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathComputationService" - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - 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.PathComputationService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - 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.PathServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathServiceEndPoint" - schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.Capacity" - 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.Capacity" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.Capacity" - 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.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.Capacity" - 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.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.BandwidthProfile" - 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.BandwidthProfile" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/total-size/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/service-interface-point/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathObjectiveFunction" - schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathObjectiveFunction.body-param" - description: "tapi.path.computation.PathObjectiveFunction to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathObjectiveFunction.body-param" - description: "tapi.path.computation.PathObjectiveFunction to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathOptimizationConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathOptimizationConstraint.body-param" - description: "tapi.path.computation.PathOptimizationConstraint to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathOptimizationConstraint.body-param" - description: "tapi.path.computation.PathOptimizationConstraint to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.RoutingConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.RoutingConstraint.body-param" - description: "tapi.path.computation.RoutingConstraint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.RoutingConstraint.body-param" - description: "tapi.path.computation.RoutingConstraint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.TopologyConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.TopologyConstraint.body-param" - description: "tapi.path.computation.TopologyConstraint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.TopologyConstraint.body-param" - description: "tapi.path.computation.TopologyConstraint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/avoid-topology={topology-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of avoid-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of exclude-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of include-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-topology={topology-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.Path" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.Path" - schema: - $ref: "#/definitions/tapi.path.computation.Path" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.RoutingConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/service-interface-point/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePoint" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/available-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/total-potential-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyContext" - parameters: [] - responses: - 200: - description: "tapi.topology.TopologyContext" - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-topology" - description: "creates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.context.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-topology" - description: "creates or updates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.context.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-topology" - description: "removes tapi.topology.TopologyContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/topology-context/nw-topology-service/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NetworkTopologyService" - parameters: [] - responses: - 200: - description: "tapi.topology.NetworkTopologyService" - schema: - $ref: "#/definitions/tapi.topology.NetworkTopologyService" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "topology-uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Topology" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Topology" - schema: - $ref: "#/definitions/tapi.topology.Topology" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Link" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Link" - schema: - $ref: "#/definitions/tapi.topology.Link" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/resilience-type/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ValidationMechanism" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "validation-mechanism" - in: "path" - description: "Id of validation-mechanism" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ValidationMechanism" - schema: - $ref: "#/definitions/tapi.topology.ValidationMechanism" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.topology.Node" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.topology.Node" - schema: - $ref: "#/definitions/tapi.topology.topology.Node" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroup" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroup" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-rule-group-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroupRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.InterRuleGroup" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.InterRuleGroup" - schema: - $ref: "#/definitions/tapi.topology.InterRuleGroup" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-rule-group-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroupRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Rule" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Rule" - schema: - $ref: "#/definitions/tapi.topology.Rule" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Rule" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Rule" - schema: - $ref: "#/definitions/tapi.topology.Rule" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.node.OwnedNodeEdgePoint" - parameters: - - name: "uuid" - 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.OwnedNodeEdgePoint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - 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.context.topologycontext.topology.node.ownednodeedgepoint.CepList" - schema: - $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ceplist.ConnectionEndPoint" - parameters: - - name: "uuid" - 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.ceplist.ConnectionEndPoint" - schema: - $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/aggregated-connection-end-point={topology-uuid},{aggregated-connection-end-point-node-uuid},{node-edge-point-uuid},{aggregated-connection-end-point-connection-end-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" - parameters: - - name: "uuid" - 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.ConnectionEndPointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/client-node-edge-point={topology-uuid},{client-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - 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.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MepMipList" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MepMipList" - schema: - $ref: "#/definitions/tapi.oam.MepMipList" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mep={meg-uuid},{mep-local-id}/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MepRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "meg-uuid" - in: "path" - description: "Id of mep" - required: true - type: "string" - - name: "mep-local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MepRef" - schema: - $ref: "#/definitions/tapi.oam.MepRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mip={meg-uuid},{mip-local-id}/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MipRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "meg-uuid" - in: "path" - description: "Id of mip" - required: true - type: "string" - - name: "mip-local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MipRef" - schema: - $ref: "#/definitions/tapi.oam.MipRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/name={value-name}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/parent-node-edge-point/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "service-interface-point-uuid" - in: "path" - description: "Id of mapped-service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /operations/compute-p-2-p-path/: - post: - tags: - - "tapi-path-computation" - parameters: - - in: "body" - name: "tapi.path.computation.computep2ppath.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.path.computation.computep2ppath.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.path.computation.ComputeP2PPath" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-connectivity-service/: - post: - tags: - - "tapi-connectivity" - parameters: - - in: "body" - name: "tapi.connectivity.createconnectivityservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.connectivity.createconnectivityservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.connectivity.CreateConnectivityService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-notification-subscription-service/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.CreateNotificationSubscriptionService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-oam-job/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.createoamjob.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.createoamjob.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.CreateOamJob" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-oam-service-end-point/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.createoamserviceendpoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.createoamserviceendpoint.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.CreateOamServiceEndPoint" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-oam-service/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.createoamservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.createoamservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.CreateOamService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/delete-connectivity-service/: - post: - tags: - - "tapi-connectivity" - 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/delete-notification-subscription-service/: - post: - tags: - - "tapi-notification" - 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/delete-oam-job/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.deleteoamjob.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.deleteoamjob.Input" - responses: - 201: - description: "No response" - 400: - description: "Internal error" - /operations/delete-oam-service-end-point/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.deleteoamserviceendpoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.deleteoamserviceendpoint.Input" - responses: - 201: - description: "No response" - 400: - description: "Internal error" - /operations/delete-oam-service/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.deleteoamservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.deleteoamservice.Input" - responses: - 201: - description: "No response" - 400: - description: "Internal error" - /operations/delete-p-2-p-path/: - post: - tags: - - "tapi-path-computation" - 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/get-connection-details/: - post: - tags: - - "tapi-connectivity" - 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/get-connection-end-point-details/: - post: - tags: - - "tapi-connectivity" - 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/get-connectivity-service-details/: - post: - tags: - - "tapi-connectivity" - 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/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/get-link-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.getlinkdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.getlinkdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetLinkDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-meg/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.getmeg.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.getmeg.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.GetMeg" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-node-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.getnodedetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.getnodedetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetNodeDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-node-edge-point-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.getnodeedgepointdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetNodeEdgePointDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-list/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.getnotificationlist.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.getnotificationlist.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-subscription-service-details/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-subscription-service-list/: - post: - tags: - - "tapi-notification" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-oam-job/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.getoamjob.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.getoamjob.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.GetOamJob" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-oam-service-end-point/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.getoamserviceendpoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.getoamserviceendpoint.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.GetOamServiceEndPoint" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-oam-service-list/: - post: - tags: - - "tapi-oam" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.GetOamServiceList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-oam-service/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.getoamservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.getoamservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.GetOamService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-service-interface-point-details/: - post: - tags: - - "tapi-common" - parameters: - - in: "body" - name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.common.GetServiceInterfacePointDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-service-interface-point-list/: - post: - tags: - - "tapi-common" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.common.GetServiceInterfacePointList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-supported-notification-types/: - post: - tags: - - "tapi-notification" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetSupportedNotificationTypes" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-topology-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.gettopologydetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.gettopologydetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetTopologyDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-topology-list/: - post: - tags: - - "tapi-topology" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetTopologyList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/optimize-p-2-p-path/: - post: - tags: - - "tapi-path-computation" - 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/update-connectivity-service/: - post: - tags: - - "tapi-connectivity" - 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/update-notification-subscription-service/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.UpdateNotificationSubscriptionService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-oam-job/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.updateoamjob.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.updateoamjob.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.UpdateOamJob" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-oam-service-end-point/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.updateoamserviceendpoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.updateoamserviceendpoint.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.UpdateOamServiceEndPoint" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-oam-service/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.updateoamservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.updateoamservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.UpdateOamService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-service-interface-point/: - post: - tags: - - "tapi-common" - parameters: - - in: "body" - name: "tapi.common.updateserviceinterfacepoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.common.updateserviceinterfacepoint.Input" - responses: - 201: - description: "No response" - 400: - description: "Internal error" -definitions: - tapi.common.AdminStatePac: - type: "object" - properties: - operational-state: - description: "none" - $ref: "#/definitions/tapi.common.OperationalState" - lifecycle-state: - description: "none" - $ref: "#/definitions/tapi.common.LifecycleState" - administrative-state: - description: "none" - $ref: "#/definitions/tapi.common.AdministrativeState" - tapi.common.AdministrativeState: - type: "string" - enum: - - "LOCKED" - - "UNLOCKED" - tapi.common.BandwidthProfile: - type: "object" - properties: - committed-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - coupling-flag: - type: "boolean" - description: "none" - default: false - bw-profile-type: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfileType" - peak-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - committed-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - peak-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - color-aware: - type: "boolean" - description: "none" - default: false - tapi.common.BandwidthProfileType: - type: "string" - enum: - - "MEF_10.x" - - "RFC_2697" - - "RFC_2698" - - "RFC_4115" - tapi.common.Capacity: - type: "object" - properties: - bandwidth-profile: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfile" - total-size: - description: "Total capacity of the TopologicalEntity in MB/s. In case of\ - \ bandwidthProfile, this is expected to same as the committedInformationRate." - $ref: "#/definitions/tapi.common.CapacityValue" - tapi.common.CapacityPac: - type: "object" - properties: - available-capacity: - description: "Capacity available to be assigned." - $ref: "#/definitions/tapi.common.Capacity" - total-potential-capacity: - description: "An optimistic view of the capacity of the TopologicalEntity\ - \ assuming that any shared capacity is available to be taken." - $ref: "#/definitions/tapi.common.Capacity" - tapi.common.CapacityUnit: - type: "string" - enum: - - "TB" - - "TBPS" - - "GB" - - "GBPS" - - "MB" - - "MBPS" - - "KB" - - "KBPS" - - "GHz" - - "MHz" - tapi.common.CapacityValue: - type: "object" - properties: - value: - type: "integer" - format: "int32" - description: "none" - unit: - description: "none" - $ref: "#/definitions/tapi.common.CapacityUnit" - tapi.common.Context: - allOf: - - $ref: "#/definitions/tapi.common.TapiContext" - - $ref: "#/definitions/tapi.connectivity.ContextAugmentation4" - - $ref: "#/definitions/tapi.notification.ContextAugmentation2" - - $ref: "#/definitions/tapi.oam.ContextAugmentation1" - - $ref: "#/definitions/tapi.path.computation.ContextAugmentation3" - - $ref: "#/definitions/tapi.topology.ContextAugmentation5" - 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.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" - description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ - \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ - \ circuit and packet forms." - tapi.common.ServiceInterfacePointRef: - type: "object" - properties: - service-interface-point-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-common:service-interface-point/tapi-common:uuid" - tapi.common.TapiContext: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - service-interface-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - description: "The Network Control Domain (NCD) object class represents the scope\ - \ of control that a particular SDN controller has with respect to a particular\ - \ network, (i.e., encompassing a designated set of interconnected (virtual)\ - \ network elements)." - tapi.common.TerminationDirection: - type: "string" - enum: - - "BIDIRECTIONAL" - - "SINK" - - "SOURCE" - - "UNDEFINED_OR_UNKNOWN" - tapi.common.TerminationPac: - type: "object" - properties: - termination-direction: - description: "The overall directionality of the LP. \r\n \ - \ - A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ - \ - A SINK LP can only contain elements with SINK flows\ - \ or CONTRA_DIRECTION_SOURCE flows\r\n - A SOURCE LP\ - \ can only contain SOURCE flows or CONTRA_DIRECTION_SINK flows" - $ref: "#/definitions/tapi.common.TerminationDirection" - termination-state: - description: "Indicates whether the layer is terminated and if so how." - $ref: "#/definitions/tapi.common.TerminationState" - tapi.common.TerminationState: - type: "string" - enum: - - "LP_CAN_NEVER_TERMINATE" - - "LT_NOT_TERMINATED" - - "TERMINATED_SERVER_TO_CLIENT_FLOW" - - "TERMINATED_CLIENT_TO_SERVER_FLOW" - - "TERMINATED_BIDIRECTIONAL" - - "LT_PERMENANTLY_TERMINATED" - - "TERMINATION_STATE_UNKNOWN" - tapi.common.TimeInterval: - type: "object" - properties: - period: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.TimePeriod" - tapi.common.TimePeriod: - type: "object" - properties: - value: - type: "integer" - format: "int32" - description: "none" - unit: - description: "none" - $ref: "#/definitions/tapi.common.TimeUnit" - tapi.common.TimeRange: - type: "object" - properties: - end-time: - type: "string" - description: "none" - start-time: - type: "string" - description: "none" - tapi.common.TimeUnit: - type: "string" - enum: - - "YEARS" - - "MONTHS" - - "DAYS" - - "HOURS" - - "MINUTES" - - "SECONDS" - - "MILLISECONDS" - - "MICROSECONDS" - - "NANOSECONDS" - - "PICOSECONDS" - 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.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" - 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" - 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.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.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" - 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" - coroute-inclusion: - description: "none" - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" - tapi.connectivity.ConnectivityContext: - type: "object" - properties: - connectivity-service: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ConnectivityService" - connection: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.Connection" - tapi.connectivity.ConnectivityService: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" - - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - - type: "object" - properties: - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" - connection: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ConnectionRef" - description: "The ForwardingConstruct (FC) object class models enabled potential\ - \ for forwarding between two or more LTPs and like the LTP supports any transport\ - \ protocol including all circuit and packet forms.\r\n At the\ - \ lowest level of recursion, a FC represents a cross-connection within an\ - \ NE." - tapi.connectivity.ConnectivityServiceEndPoint: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $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" - 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" - 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.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.ContextAugmentation4: - 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.context.topologycontext.topology.node.ownednodeedgepoint.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.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" - description: "The FC Route (FcRoute) object class models the individual routes\ - \ of an FC. \r\n The route of an FC object is represented by\ - \ a list of FCs at a lower level. \r\n Note that depending\ - \ on the service supported by an FC, an the FC can have multiple routes." - 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.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.UpdateConnectivityService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.connectivity.updateconnectivityservice.Output" - tapi.connectivity.ceplist.ConnectionEndPoint: - allOf: - - $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" - - $ref: "#/definitions/tapi.oam.ConnectionEndPointAugmentation1" - tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList: - allOf: - - type: "object" - properties: - connection-end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" - description: "none" - 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.ContextAugmentation2: - 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.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.NotificationContext: - type: "object" - properties: - notif-subscription: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - notification: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.Notification" - tapi.notification.NotificationSubscriptionService: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - notification: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.Notification" - notification-channel: - description: "none" - $ref: "#/definitions/tapi.notification.NotificationChannel" - subscription-state: - description: "none" - $ref: "#/definitions/tapi.notification.SubscriptionState" - supported-object-types: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.ObjectType" - supported-notification-types: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.NotificationType" - subscription-filter: - description: "none" - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - description: "none" - tapi.notification.NotificationType: - type: "string" - enum: - - "OBJECT_CREATION" - - "OBJECT_DELETION" - - "ATTRIBUTE_VALUE_CHANGE" - - "ALARM_EVENT" - - "THRESHOLD_CROSSING_ALERT" - tapi.notification.ObjectType: - type: "string" - enum: - - "TOPOLOGY" - - "NODE" - - "LINK" - - "CONNECTION" - - "PATH" - - "CONNECTIVITY_SERVICE" - - "VIRTUAL_NETWORK_SERVICE" - - "PATH_COMPUTATION_SERVICE" - - "NODE_EDGE_POINT" - - "SERVICE_INTERFACE_POINT" - - "CONNECTION_END_POINT" - - "MAINTENANCE_ENTITY_GROUP" - - "MAINTENANCE_ENTITY" - - "MEG_END_POINT" - - "MEG_INTERMEDIATE_POINT" - - "SWITCH_CONTROL" - - "SWITCH" - - "ROUTE" - - "NODE_RULE_GROUP" - - "INTER_RULE_GROUP" - - "RULE" - - "OAM_JOB" - tapi.notification.PerceivedSeverityType: - type: "string" - enum: - - "CRITICAL" - - "MAJOR" - - "MINOR" - - "WARNING" - - "CLEARED" - tapi.notification.PerceivedTcaSeverity: - type: "string" - enum: - - "WARNING" - - "CLEAR" - tapi.notification.ServiceAffecting: - type: "string" - enum: - - "SERVICE_AFFECTING" - - "NOT_SERVICE_AFFECTING" - - "UNKNOWN" - 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.SubscriptionState: - type: "string" - enum: - - "SUSPENDED" - - "ACTIVE" - tapi.notification.TcaInfo: - type: "object" - properties: - threshold-crossing: - description: "none" - $ref: "#/definitions/tapi.notification.ThresholdCrossingType" - threshold-parameter: - type: "string" - description: "none" - is-transient: - type: "boolean" - description: "none" - default: false - threshold-value: - type: "integer" - format: "int32" - description: "none" - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedTcaSeverity" - suspect-interval-flag: - type: "boolean" - description: "none" - default: false - measurement-interval: - type: "string" - description: "none" - tapi.notification.ThresholdCrossingType: - type: "string" - enum: - - "THRESHOLD_ABOVE" - - "THRESHOLD_BELOW" - - "CLEARED" - tapi.notification.UpdateNotificationSubscriptionService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Output" - tapi.notification.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.oam.ConnectionEndPointAugmentation1: - type: "object" - properties: - mep-mip-list: - description: "none" - $ref: "#/definitions/tapi.oam.MepMipList" - x-augmentation: - prefix: "tapi-oam" - namespace: "urn:onf:otcc:yang:tapi-oam" - tapi.oam.ContextAugmentation1: - type: "object" - properties: - oam-context: - description: "Augments the base TAPI Context with OamService information" - $ref: "#/definitions/tapi.oam.OamContext" - x-augmentation: - prefix: "tapi-oam" - namespace: "urn:onf:otcc:yang:tapi-oam" - tapi.oam.CreateOamJob: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.createoamjob.Output" - tapi.oam.CreateOamService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.createoamservice.Output" - tapi.oam.CreateOamServiceEndPoint: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.createoamserviceendpoint.Output" - tapi.oam.GetMeg: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.getmeg.Output" - tapi.oam.GetOamJob: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.getoamjob.Output" - tapi.oam.GetOamService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.getoamservice.Output" - tapi.oam.GetOamServiceEndPoint: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.getoamserviceendpoint.Output" - tapi.oam.GetOamServiceList: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.getoamservicelist.Output" - tapi.oam.Meg: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.common.OperationalStatePac" - - type: "object" - properties: - meg-identifier: - type: "string" - description: "none" - meg-level: - type: "integer" - format: "int32" - description: "none" - mip: - type: "array" - description: "ME may 0, 1, or more MIPs" - items: - $ref: "#/definitions/tapi.oam.Mip" - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - mep: - type: "array" - description: "1. ME may have 0 MEPs (case of transit domains where at least\ - \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case\ - \ of edge domaind, where the peer MEP is ouside the managed domain)\r\n\ - \ 3. ME may have 2 MEPs" - items: - $ref: "#/definitions/tapi.oam.Mep" - direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" - description: "none" - tapi.oam.MegRef: - type: "object" - properties: - meg-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:uuid" - tapi.oam.Mep: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - $ref: "#/definitions/tapi.common.OperationalStatePac" - - type: "object" - properties: - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - peer-mep-identifier: - type: "array" - description: "none" - items: - type: "string" - mep-identifier: - type: "string" - description: "none" - direction: - description: "none" - $ref: "#/definitions/tapi.common.TerminationDirection" - description: "none" - tapi.oam.MepMipList: - type: "object" - properties: - mip: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.MipRef" - mep: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.MepRef" - tapi.oam.MepRef: - allOf: - - $ref: "#/definitions/tapi.oam.MegRef" - - type: "object" - properties: - mep-local-id: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:mep/tapi-oam:local-id" - description: "none" - tapi.oam.Mip: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - description: "none" - tapi.oam.MipRef: - allOf: - - $ref: "#/definitions/tapi.oam.MegRef" - - type: "object" - properties: - mip-local-id: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:mip/tapi-oam:local-id" - description: "none" - tapi.oam.OamConstraint: - type: "object" - properties: - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - meg-level: - type: "integer" - format: "int32" - description: "none" - direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" - tapi.oam.OamContext: - type: "object" - properties: - oam-service: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamService" - oam-profile: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamProfile" - oam-job: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamJob" - meg: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.Meg" - tapi.oam.OamJob: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - schedule: - description: "none" - $ref: "#/definitions/tapi.common.TimeRange" - oam-profile: - description: "none" - $ref: "#/definitions/tapi.oam.OamProfileRef" - pm-current-data: - type: "array" - description: "Granularity period of the CurrentData identifies the specific\ - \ CurrentData instance in the scope of this OamJob.\r\n \ - \ For example, typically at least\r\n one 15min\ - \ and\r\n one 24hr;\r\n optionally\ - \ one additional configurable (< 15min)" - items: - $ref: "#/definitions/tapi.oam.PmCurrentData" - creation-time: - type: "string" - description: "none" - oam-service-end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" - oam-job-type: - type: "string" - description: "none" - description: "none" - tapi.oam.OamProfile: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - pm-threshold-data: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.PmThresholdData" - pm-bin-data: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.PmBinData" - description: "none" - tapi.oam.OamProfileRef: - type: "object" - properties: - oam-profile-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-profile/tapi-oam:uuid" - tapi.oam.OamService: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.oam.OamConstraint" - - type: "object" - properties: - oam-profile: - description: "none" - $ref: "#/definitions/tapi.oam.OamProfileRef" - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - meg: - description: "none" - $ref: "#/definitions/tapi.oam.MegRef" - description: "none" - tapi.oam.OamServiceEndPoint: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - peer-mep-identifier: - type: "array" - description: "This attribute models the MI_PeerMEP_ID[i] defined in G.8021\ - \ and configured as specified in G.8051. It provides the identifiers of\ - \ the MEPs which are peer to the subject MEP.\r\n This\ - \ attribute is not specified in case the OSEP relates to the provisioing\ - \ of an MIP.\r\n In case of P2P, there is only one\ - \ peer" - items: - type: "string" - connectivity-service-end-point: - description: "none" - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" - mip: - description: "none" - $ref: "#/definitions/tapi.oam.MipRef" - service-interface-point: - description: "none" - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - mep: - description: "none" - $ref: "#/definitions/tapi.oam.MepRef" - mep-identifier: - type: "string" - description: "This attribute contains the identifier of the MEP.\r\n \ - \ This attribute is empty in case the OSEP relates to\ - \ the provisioing of an MIP.\r\n " - direction: - description: "none" - $ref: "#/definitions/tapi.common.PortDirection" - description: "none" - tapi.oam.OamServiceEndPointRef: - allOf: - - $ref: "#/definitions/tapi.oam.OamServiceRef" - - type: "object" - properties: - oam-service-end-point-local-id: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:end-point/tapi-oam:local-id" - description: "none" - tapi.oam.OamServiceRef: - type: "object" - properties: - oam-service-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:uuid" - tapi.oam.PmBinData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - description: "none" - tapi.oam.PmCurrentData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - elapsed-time: - description: "none" - $ref: "#/definitions/tapi.common.TimeInterval" - pm-history-data: - type: "array" - description: "in case of 24hr Current Data, at least 1 History Data.\r\n\ - \ In case of 15min Current Data, at least 16 History\ - \ Data.\r\n In case of <15min, the number of History\ - \ Data shall be able to cover a span of 4 hours." - items: - $ref: "#/definitions/tapi.oam.PmHistoryData" - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - suspect-interval-flag: - type: "boolean" - description: "This attribute is used to indicate that the performance data\ - \ for the current period may not be reliable. Some reasons for this to\ - \ occur are:\r\n – Suspect data were detected by the\ - \ actual resource doing data collection.\r\n – Transition\ - \ of the administrativeState attribute to/from the 'lock' state.\r\n \ - \ – Transition of the operationalState to/from the 'disabled'\ - \ state.\r\n – Scheduler setting that inhibits the\ - \ collection function.\r\n – The performance counters\ - \ were reset during the interval.\r\n – The currentData\ - \ (or subclass) object instance was created during the monitoring period." - default: false - timestamp: - type: "string" - description: "This attribute indicates the start of the current monitoring\ - \ interval.\r\n The value is bound to the quarter of\ - \ an hour in case of a 15 minute interval and bound to the hour in case\ - \ of a 24 hour interval." - description: "none" - tapi.oam.PmHistoryData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - period-end-time: - type: "string" - description: "none" - suspect-interval-flag: - type: "boolean" - description: "This attribute indicates that the performance data may not\ - \ be reliable." - default: false - description: "none" - tapi.oam.PmThresholdData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - is-transient: - type: "boolean" - description: "none" - default: false - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - description: "none" - tapi.oam.UpdateOamJob: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.updateoamjob.Output" - tapi.oam.UpdateOamService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.updateoamservice.Output" - tapi.oam.UpdateOamServiceEndPoint: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.updateoamserviceendpoint.Output" - tapi.oam.createoamjob.Input: - type: "object" - properties: - schedule: - type: "string" - description: "none" - oam-service-end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - oam-job-type: - type: "string" - description: "none" - oam-profile: - description: "none" - $ref: "#/definitions/tapi.oam.OamProfile" - state: - type: "string" - description: "none" - tapi.oam.createoamjob.Output: - type: "object" - properties: - oam-job: - description: "none" - $ref: "#/definitions/tapi.oam.OamJob" - tapi.oam.createoamservice.Input: - type: "object" - properties: - oam-constraint: - description: "none" - $ref: "#/definitions/tapi.oam.OamConstraint" - state: - type: "string" - description: "none" - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.oam.createoamservice.Output: - type: "object" - properties: - service: - description: "none" - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.createoamserviceendpoint.Input: - type: "object" - properties: - peer-mep-identifier: - type: "array" - description: "none" - items: - type: "string" - service-id: - type: "string" - description: "none" - sip-id: - type: "string" - description: "none" - c-sep-id: - type: "string" - description: "none" - mep-identifier: - type: "string" - description: "none" - state: - type: "string" - description: "none" - layer: - type: "string" - description: "none" - direction: - type: "string" - description: "none" - tapi.oam.createoamserviceendpoint.Output: - type: "object" - properties: - end-point: - description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.oam.deleteoamjob.Input: - type: "object" - properties: - job-id: - type: "string" - description: "none" - tapi.oam.deleteoamservice.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - tapi.oam.deleteoamserviceendpoint.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - o-sep-id: - type: "string" - description: "none" - tapi.oam.getmeg.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - tapi.oam.getmeg.Output: - type: "object" - properties: - meg: - description: "none" - $ref: "#/definitions/tapi.oam.Meg" - tapi.oam.getoamjob.Input: - type: "object" - properties: - job-id: - type: "string" - description: "none" - tapi.oam.getoamjob.Output: - type: "object" - properties: - oam-job: - description: "none" - $ref: "#/definitions/tapi.oam.OamJob" - tapi.oam.getoamservice.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - tapi.oam.getoamservice.Output: - type: "object" - properties: - service: - description: "none" - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.getoamserviceendpoint.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - o-sep-id: - type: "string" - description: "none" - tapi.oam.getoamserviceendpoint.Output: - type: "object" - properties: - end-point: - description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.oam.getoamservicelist.Output: - type: "object" - properties: - service: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.updateoamjob.Input: - type: "object" - properties: - job-id: - type: "string" - description: "none" - schedule: - type: "string" - description: "none" - oam-profile: - description: "none" - $ref: "#/definitions/tapi.oam.OamProfile" - state: - type: "string" - description: "none" - tapi.oam.updateoamjob.Output: - type: "object" - properties: - oam-job: - description: "none" - $ref: "#/definitions/tapi.oam.OamJob" - tapi.oam.updateoamservice.Input: - type: "object" - properties: - oam-constraint: - description: "none" - $ref: "#/definitions/tapi.oam.OamConstraint" - service-id: - type: "string" - description: "none" - state: - type: "string" - description: "none" - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.oam.updateoamservice.Output: - type: "object" - properties: - service: - description: "none" - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.updateoamserviceendpoint.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - o-sep-id: - type: "string" - description: "none" - state: - type: "string" - description: "none" - tapi.oam.updateoamserviceendpoint.Output: - type: "object" - properties: - end-point: - description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.path.computation.ComputeP2PPath: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.path.computation.computep2ppath.Output" - tapi.path.computation.ContextAugmentation3: - 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.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.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.PathOptimizationConstraint: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - traffic-interruption: - description: "none" - $ref: "#/definitions/tapi.common.DirectiveValue" - description: "none" - 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.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.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 - 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" - 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.TopologyConstraint: - type: "object" - properties: - include-node: - type: "array" - description: "This is a loose constraint - that is it is unordered and could\ - \ be a partial list" - items: - $ref: "#/definitions/tapi.topology.NodeRef" - exclude-link: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.LinkRef" - avoid-topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - exclude-path: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.path.computation.PathRef" - include-link: - type: "array" - description: "This is a loose constraint - that is it is unordered and could\ - \ be a partial list " - items: - $ref: "#/definitions/tapi.topology.LinkRef" - preferred-transport-layer: - type: "array" - description: "soft constraint requested by client to indicate the layer(s)\ - \ of transport connection that it prefers to carry the service. This could\ - \ be same as the service layer or one of the supported server layers" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - exclude-node: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRef" - include-topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - include-path: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.path.computation.PathRef" - 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.ContextAugmentation5: - type: "object" - properties: - topology-context: - description: "Augments the base TAPI Context with TopologyService information" - $ref: "#/definitions/tapi.topology.TopologyContext" - x-augmentation: - prefix: "tapi-topology" - namespace: "urn:onf:otcc:yang:tapi-topology" - tapi.topology.CostCharacteristic: - type: "object" - properties: - cost-value: - type: "string" - description: "The specific cost." - cost-algorithm: - type: "string" - description: "The cost may vary based upon some properties of the TopologicalEntity.\ - \ The rules for the variation are conveyed by the costAlgorithm." - cost-name: - type: "string" - description: "The cost characteristic will related to some aspect of the TopologicalEntity\ - \ (e.g. $ cost, routing weight). This aspect will be conveyed by the costName." - tapi.topology.ForwardingRule: - type: "string" - enum: - - "MAY_FORWARD_ACROSS_GROUP" - - "MUST_FORWARD_ACROSS_GROUP" - - "CANNOT_FORWARD_ACROSS_GROUP" - - "NO_STATEMENT_ON_FORWARDING" - tapi.topology.GetLinkDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.getlinkdetails.Output" - tapi.topology.GetNodeDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.getnodedetails.Output" - tapi.topology.GetNodeEdgePointDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Output" - tapi.topology.GetTopologyDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.gettopologydetails.Output" - tapi.topology.GetTopologyList: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.gettopologylist.Output" - tapi.topology.InterRuleGroup: - allOf: - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.RiskParameterPac" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - type: "object" - properties: - associated-node-rule-group: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - rule: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Rule" - description: "none" - tapi.topology.LatencyCharacteristic: - type: "object" - properties: - traffic-property-name: - type: "string" - description: "The identifier of the specific traffic property to which the\ - \ queuing latency applies." - jitter-characteristic: - type: "string" - description: "High frequency deviation from true periodicity of a signal and\ - \ therefore a small high rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." - fixed-latency-characteristic: - type: "string" - description: "A TopologicalEntity suffers delay caused by the realization\ - \ of the servers (e.g. distance related; FEC encoding etc.) along with some\ - \ client specific processing. This is the total average latency effect of\ - \ the TopologicalEntity" - wander-characteristic: - type: "string" - description: "Low frequency deviation from true periodicity of a signal and\ - \ therefore a small low rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." - queing-latency-characteristic: - type: "string" - description: "The specific queuing latency for the traffic property." - tapi.topology.LayerProtocolTransitionPac: - type: "object" - properties: - transitioned-layer-protocol-name: - type: "array" - description: "Provides the ordered structure of layer protocol transitions\ - \ encapsulated in the TopologicalEntity. The ordering relates to the LinkPort\ - \ role." - items: - type: "string" - tapi.topology.Link: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.LayerProtocolTransitionPac" - - $ref: "#/definitions/tapi.topology.RiskParameterPac" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - $ref: "#/definitions/tapi.topology.ValidationPac" - - type: "object" - properties: - layer-protocol-name: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - 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.NetworkTopologyService: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - description: "none" - tapi.topology.Node: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - type: "object" - properties: - layer-protocol-name: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - encap-topology: - description: "none" - $ref: "#/definitions/tapi.topology.TopologyRef" - 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.NodeRef: - allOf: - - $ref: "#/definitions/tapi.topology.TopologyRef" - - type: "object" - properties: - node-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:uuid" - description: "none" - tapi.topology.NodeRuleGroup: - allOf: - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.RiskParameterPac" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - type: "object" - properties: - inter-rule-group: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.InterRuleGroup" - rule: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Rule" - composed-rule-group: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - node-edge-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - description: "none" - tapi.topology.NodeRuleGroupRef: - allOf: - - $ref: "#/definitions/tapi.topology.NodeRef" - - type: "object" - properties: - node-rule-group-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-rule-group/tapi-topology:uuid" - description: "none" - tapi.topology.ProtectionType: - type: "string" - enum: - - "NO_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" - 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.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.RiskParameterPac: - type: "object" - properties: - risk-characteristic: - type: "array" - description: "A list of risk characteristics for consideration in an analysis\ - \ of shared risk. Each element of the list represents a specific risk consideration." - items: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - tapi.topology.Rule: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - override-priority: - type: "integer" - format: "int32" - description: "none" - forwarding-rule: - description: "none" - $ref: "#/definitions/tapi.topology.ForwardingRule" - rule-type: - description: "none" - $ref: "#/definitions/tapi.topology.RuleType" - description: "none" - tapi.topology.RuleType: - type: "string" - enum: - - "FORWARDING" - - "CAPACITY" - - "COST" - - "TIMING" - - "RISK" - - "GROUPING" - tapi.topology.Topology: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - layer-protocol-name: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - link: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Link" - node: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Node" - description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ - \ topological component which is used to effect forwarding of transport characteristic\ - \ information and offers the potential to enable forwarding. \r\n \ - \ At the lowest level of recursion, an FD (within a network element\ - \ (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ - \ multiple switch matrices (FDs). " - tapi.topology.TopologyContext: - type: "object" - properties: - nw-topology-service: - description: "none" - $ref: "#/definitions/tapi.topology.NetworkTopologyService" - topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Topology" - tapi.topology.TopologyRef: - type: "object" - properties: - topology-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:uuid" - tapi.topology.TransferCostPac: - type: "object" - properties: - cost-characteristic: - type: "array" - description: "The list of costs where each cost relates to some aspect of\ - \ the TopologicalEntity." - items: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - tapi.topology.TransferIntegrityPac: - type: "object" - properties: - error-characteristic: - type: "string" - description: "Describes the degree to which the signal propagated can be errored.\ - \ \r\n Applies to TDM systems as the errored signal will\ - \ be propagated and not packet as errored packets will be discarded." - unavailable-time-characteristic: - type: "string" - description: "Describes the duration for which there may be no valid signal\ - \ propagated." - server-integrity-process-characteristic: - type: "string" - description: "Describes the effect of any server integrity enhancement process\ - \ on the characteristics of the TopologicalEntity." - delivery-order-characteristic: - type: "string" - description: "Describes the degree to which packets will be delivered out\ - \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ - \ maintain strict order." - repeat-delivery-characteristic: - type: "string" - description: "Primarily applies to packet systems where a packet may be delivered\ - \ more than once (in fault recovery for example). \r\n \ - \ It can also apply to TDM where several frames may be received twice\ - \ due to switching in a system with a large differential propagation delay." - loss-characteristic: - type: "string" - description: "Describes the acceptable characteristic of lost packets where\ - \ loss may result from discard due to errors or overflow.\r\n \ - \ Applies to packet systems and not TDM (as for TDM errored signals\ - \ are propagated unless grossly errored and overflow/underflow turns into\ - \ timing slips)." - tapi.topology.TransferTimingPac: - type: "object" - properties: - latency-characteristic: - type: "array" - description: "The effect on the latency of a queuing process. This only has\ - \ significant effect for packet based systems and has a complex characteristic." - items: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - tapi.topology.ValidationMechanism: - type: "object" - properties: - layer-protocol-adjacency-validated: - type: "string" - description: "State of validatiion" - validation-mechanism: - type: "string" - description: "Name of mechanism used to validate adjacency" - validation-robustness: - type: "string" - description: "Quality of validation (i.e. how likely is the stated validation\ - \ to be invalid)" - tapi.topology.ValidationPac: - type: "object" - properties: - validation-mechanism: - type: "array" - description: "Provides details of the specific validation mechanism(s) used\ - \ to confirm the presence of an intended topologicalEntity." - items: - $ref: "#/definitions/tapi.topology.ValidationMechanism" - tapi.topology.getlinkdetails.Input: - type: "object" - properties: - link-id-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.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" diff --git a/OAS/tapi-eth@2018-12-10.yaml b/OAS/tapi-eth@2018-12-10.yaml deleted file mode 100644 index 326ad14e..00000000 --- a/OAS/tapi-eth@2018-12-10.yaml +++ /dev/null @@ -1,24319 +0,0 @@ ---- -swagger: "2.0" -info: - description: "tapi-oam,tapi-path-computation,tapi-connectivity,tapi-dsr,tapi-notification,tapi-topology,tapi-eth,tapi-common\ - \ API generated from yang definitions" - version: "1.0" - title: "tapi-oam,tapi-path-computation,tapi-connectivity,tapi-dsr,tapi-notification,tapi-topology,tapi-eth,tapi-common\ - \ API" -host: "localhost:1234" -consumes: -- "application/yang-data+json" -produces: -- "application/yang-data+json" -paths: - /data/context/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Context" - parameters: [] - responses: - 200: - description: "tapi.common.Context" - schema: - $ref: "#/definitions/tapi.common.Context" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.Context" - parameters: - - in: "body" - name: "tapi.common.Context.body-param" - description: "tapi.common.Context to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.Context" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.Context" - parameters: - - in: "body" - name: "tapi.common.Context.body-param" - description: "tapi.common.Context to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.Context" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.Context" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityContext" - parameters: [] - responses: - 200: - description: "tapi.connectivity.ConnectivityContext" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityContext" - 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.ConnectivityContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityContext" - 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.ConnectivityContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connection={uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.Connection" - parameters: - - name: "uuid" - in: "path" - description: "Id of connection" - required: true - type: "string" - responses: - 200: - description: "tapi.connectivity.Connection" - schema: - $ref: "#/definitions/tapi.connectivity.Connection" - 400: - description: "Internal error" - ? /data/context/connectivity-context/connection={uuid}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" - 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.ConnectionEndPointRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/lower-connection={connection-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionRef" - 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.ConnectionRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - 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.NameAndValue" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/route={local-id}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.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.Route" - schema: - $ref: "#/definitions/tapi.connectivity.Route" - 400: - description: "Internal error" - ? /data/context/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" - description: "returns tapi.connectivity.ConnectionEndPointRef" - 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.ConnectionEndPointRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/route={local-id}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - 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.NameAndValue" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/supported-client-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" - 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.LinkRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.SwitchControl" - 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.SwitchControl" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - 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.NameAndValue" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/resilience-type/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of connection" - required: true - type: "string" - - name: "switch-control-uuid" - in: "path" - description: "Id of switch-control" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" - ? /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/sub-switch-control={connection-uuid},{sub-switch-control-switch-control-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.SwitchControlRef" - 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.SwitchControlRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/switch={local-id}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.Switch" - 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.Switch" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/switch={local-id}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - 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.NameAndValue" - 400: - description: "Internal error" - ? /data/context/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" - description: "returns tapi.connectivity.ConnectionEndPointRef" - 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.ConnectionEndPointRef" - 400: - description: "Internal error" - ? /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/switch={local-id}/selected-route={connection-uuid},{route-local-id}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.RouteRef" - 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.RouteRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityService" - 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.ConnectivityService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityService" - 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.ConnectivityService" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityService" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityService.body-param" - description: "tapi.connectivity.ConnectivityService to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityService" - 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.ConnectivityService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityService" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/avoid-topology={topology-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of avoid-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/connection={connection-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionRef" - 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.ConnectionRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/coroute-inclusion/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceRef" - 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.ConnectivityServiceRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceRef" - 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.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/cost-characteristic/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.CostCharacteristic" - 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.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/diversity-exclusion/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" - 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.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/diversity-exclusion={connectivity-service-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "connectivity-service-uuid" - in: "path" - description: "Id of diversity-exclusion" - required: true - type: "string" - responses: - 200: - description: "tapi.connectivity.ConnectivityServiceRef" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "connectivity-service-uuid" - in: "path" - description: "Id of diversity-exclusion" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceRef" - 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.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "connectivity-service-uuid" - in: "path" - description: "Id of diversity-exclusion" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPoint to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceEndPoint" - 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.ConnectivityServiceEndPoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPoint to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceEndPoint" - 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.ConnectivityServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.Capacity" - 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.Capacity" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.Capacity" - 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.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.BandwidthProfile" - 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.BandwidthProfile" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/total-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.connectivity.ConnectionEndPointRef" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - 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.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/service-interface-point/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.ServiceInterfacePointRef" - 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.ServiceInterfacePointRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.ServiceInterfacePointRef" - 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.ServiceInterfacePointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.ServiceInterfacePointRef" - 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.ServiceInterfacePointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-path={path-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of exclude-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-path={path-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of include-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-topology={topology-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/latency-characteristic/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.LatencyCharacteristic" - 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.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/name/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.Capacity" - 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.Capacity" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.Capacity" - 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.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.BandwidthProfile" - 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.BandwidthProfile" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/total-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/resilience-type/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.ResilienceType" - 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.ResilienceType" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.ResilienceType" - parameters: - - name: "uuid" - 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.ResilienceType" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/risk-diversity-characteristic/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/risk-diversity-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/schedule/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.TimeRange" - 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.TimeRange" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.TimeRange" - 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.TimeRange" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.TimeRange" - parameters: - - name: "uuid" - 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.TimeRange" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.TimeRange" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationContext" - parameters: [] - responses: - 200: - description: "tapi.notification.NotificationContext" - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationContext" - parameters: - - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationContext" - parameters: - - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription/: - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" - parameters: - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NotificationSubscriptionService" - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NotificationChannel" - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.Notification" - schema: - $ref: "#/definitions/tapi.notification.Notification" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of additional-info" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of changed-attributes" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NameAndValueChange" - schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of target-object-name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/tca-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.SubscriptionFilter" - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notification={uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.Notification" - schema: - $ref: "#/definitions/tapi.notification.Notification" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/additional-info={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of additional-info" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of changed-attributes" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NameAndValueChange" - schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of target-object-name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/tca-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" - /data/context/oam-context/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.context.OamContext" - parameters: [] - responses: - 200: - description: "tapi.oam.context.OamContext" - schema: - $ref: "#/definitions/tapi.oam.context.OamContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.context.OamContext" - parameters: - - in: "body" - name: "tapi.oam.context.OamContext.body-param" - description: "tapi.oam.context.OamContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.context.OamContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.context.OamContext" - parameters: - - in: "body" - name: "tapi.oam.context.OamContext.body-param" - description: "tapi.oam.context.OamContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.context.OamContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.context.OamContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/meg={uuid}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.oamcontext.Meg" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.oamcontext.Meg" - schema: - $ref: "#/definitions/tapi.oam.oamcontext.Meg" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/eth-meg-spec/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthMegSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthMegSpec" - schema: - $ref: "#/definitions/tapi.eth.EthMegSpec" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.meg.Mep" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.meg.Mep" - schema: - $ref: "#/definitions/tapi.oam.meg.Mep" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/eth-mep-spec/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthMepSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthMepSpec" - schema: - $ref: "#/definitions/tapi.eth.EthMepSpec" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/eth-mep-spec/eth-mep-common/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthMepCommon" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthMepCommon" - schema: - $ref: "#/definitions/tapi.eth.EthMepCommon" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/eth-mep-spec/eth-mep-sink/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthMepSink" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthMepSink" - schema: - $ref: "#/definitions/tapi.eth.EthMepSink" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/eth-mep-spec/eth-mep-sink/bandwidth-report/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.BandwidthReport" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.BandwidthReport" - schema: - $ref: "#/definitions/tapi.eth.BandwidthReport" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/eth-mep-spec/eth-mep-source-pac/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthMepSource" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthMepSource" - schema: - $ref: "#/definitions/tapi.eth.EthMepSource" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.meg.Mip" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.meg.Mip" - schema: - $ref: "#/definitions/tapi.oam.meg.Mip" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/eth-mip-spec/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthMipSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthMipSpec" - schema: - $ref: "#/definitions/tapi.eth.EthMipSpec" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/oam-context/oam-job/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.oamcontext.OamJob" - parameters: - - in: "body" - name: "tapi.oam.oamcontext.OamJob.body-param" - description: "tapi.oam.oamcontext.OamJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.oamcontext.OamJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.oamcontext.OamJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.oamcontext.OamJob" - schema: - $ref: "#/definitions/tapi.oam.oamcontext.OamJob" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.oamcontext.OamJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.oam.oamcontext.OamJob.body-param" - description: "tapi.oam.oamcontext.OamJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.oamcontext.OamJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.oamcontext.OamJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.oam.oamcontext.OamJob.body-param" - description: "tapi.oam.oamcontext.OamJob to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.oamcontext.OamJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.oamcontext.OamJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-link-trace-job/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthLinkTraceJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthLinkTraceJob" - schema: - $ref: "#/definitions/tapi.eth.EthLinkTraceJob" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.EthLinkTraceJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthLinkTraceJob.body-param" - description: "tapi.eth.EthLinkTraceJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthLinkTraceJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.EthLinkTraceJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthLinkTraceJob.body-param" - description: "tapi.eth.EthLinkTraceJob to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthLinkTraceJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.EthLinkTraceJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-link-trace-job/eth-lt-msg/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthOamOperationCommonPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthOamOperationCommonPac" - schema: - $ref: "#/definitions/tapi.eth.EthOamOperationCommonPac" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.EthOamOperationCommonPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthOamOperationCommonPac.body-param" - description: "tapi.eth.EthOamOperationCommonPac to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOamOperationCommonPac" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.EthOamOperationCommonPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthOamOperationCommonPac.body-param" - description: "tapi.eth.EthOamOperationCommonPac to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOamOperationCommonPac" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.EthOamOperationCommonPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-loopback-job/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthLoopbackJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthLoopbackJob" - schema: - $ref: "#/definitions/tapi.eth.EthLoopbackJob" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.EthLoopbackJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthLoopbackJob.body-param" - description: "tapi.eth.EthLoopbackJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthLoopbackJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.EthLoopbackJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthLoopbackJob.body-param" - description: "tapi.eth.EthLoopbackJob to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthLoopbackJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.EthLoopbackJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-loopback-job/eth-lb-msg/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthOamMsgCommonPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthOamMsgCommonPac" - schema: - $ref: "#/definitions/tapi.eth.EthOamMsgCommonPac" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.EthOamMsgCommonPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthOamMsgCommonPac.body-param" - description: "tapi.eth.EthOamMsgCommonPac to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOamMsgCommonPac" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.EthOamMsgCommonPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthOamMsgCommonPac.body-param" - description: "tapi.eth.EthOamMsgCommonPac to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOamMsgCommonPac" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.EthOamMsgCommonPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-on-demand-1way-measurement-job/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthOnDemand1wayMeasurementJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthOnDemand1wayMeasurementJob" - schema: - $ref: "#/definitions/tapi.eth.EthOnDemand1wayMeasurementJob" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.EthOnDemand1wayMeasurementJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthOnDemand1wayMeasurementJob.body-param" - description: "tapi.eth.EthOnDemand1wayMeasurementJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOnDemand1wayMeasurementJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.EthOnDemand1wayMeasurementJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthOnDemand1wayMeasurementJob.body-param" - description: "tapi.eth.EthOnDemand1wayMeasurementJob to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOnDemand1wayMeasurementJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.EthOnDemand1wayMeasurementJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-on-demand-1way-measurement-job/on-demand-control-1way-sink/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthOnDemandMeasurementJobControlSink" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthOnDemandMeasurementJobControlSink" - schema: - $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSink" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.EthOnDemandMeasurementJobControlSink" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthOnDemandMeasurementJobControlSink.body-param" - description: "tapi.eth.EthOnDemandMeasurementJobControlSink to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSink" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.EthOnDemandMeasurementJobControlSink" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthOnDemandMeasurementJobControlSink.body-param" - description: "tapi.eth.EthOnDemandMeasurementJobControlSink to be added or\ - \ updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSink" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.EthOnDemandMeasurementJobControlSink" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-on-demand-1way-measurement-job/on-demand-control-1way-source/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthOnDemandMeasurementJobControlSource" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthOnDemandMeasurementJobControlSource" - schema: - $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.EthOnDemandMeasurementJobControlSource" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthOnDemandMeasurementJobControlSource.body-param" - description: "tapi.eth.EthOnDemandMeasurementJobControlSource to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.EthOnDemandMeasurementJobControlSource" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthOnDemandMeasurementJobControlSource.body-param" - description: "tapi.eth.EthOnDemandMeasurementJobControlSource to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.EthOnDemandMeasurementJobControlSource" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-on-demand-2way-measurement-job/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthOnDemand2wayMeasurementJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthOnDemand2wayMeasurementJob" - schema: - $ref: "#/definitions/tapi.eth.EthOnDemand2wayMeasurementJob" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.EthOnDemand2wayMeasurementJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthOnDemand2wayMeasurementJob.body-param" - description: "tapi.eth.EthOnDemand2wayMeasurementJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOnDemand2wayMeasurementJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.EthOnDemand2wayMeasurementJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthOnDemand2wayMeasurementJob.body-param" - description: "tapi.eth.EthOnDemand2wayMeasurementJob to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOnDemand2wayMeasurementJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.EthOnDemand2wayMeasurementJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-on-demand-2way-measurement-job/on-demand-control-2way-source/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthOnDemandMeasurementJobControlSource" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthOnDemandMeasurementJobControlSource" - schema: - $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.EthOnDemandMeasurementJobControlSource" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthOnDemandMeasurementJobControlSource.body-param" - description: "tapi.eth.EthOnDemandMeasurementJobControlSource to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.EthOnDemandMeasurementJobControlSource" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthOnDemandMeasurementJobControlSource.body-param" - description: "tapi.eth.EthOnDemandMeasurementJobControlSource to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.EthOnDemandMeasurementJobControlSource" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-pro-active-1way-measurement-job/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthProActive1wayMeasurementJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthProActive1wayMeasurementJob" - schema: - $ref: "#/definitions/tapi.eth.EthProActive1wayMeasurementJob" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.EthProActive1wayMeasurementJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthProActive1wayMeasurementJob.body-param" - description: "tapi.eth.EthProActive1wayMeasurementJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthProActive1wayMeasurementJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.EthProActive1wayMeasurementJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthProActive1wayMeasurementJob.body-param" - description: "tapi.eth.EthProActive1wayMeasurementJob to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthProActive1wayMeasurementJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.EthProActive1wayMeasurementJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-pro-active-1way-measurement-job/pro-active-control-1way-sink/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthProActiveMeasurementJobControlSink" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthProActiveMeasurementJobControlSink" - schema: - $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSink" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.EthProActiveMeasurementJobControlSink" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthProActiveMeasurementJobControlSink.body-param" - description: "tapi.eth.EthProActiveMeasurementJobControlSink to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSink" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.EthProActiveMeasurementJobControlSink" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthProActiveMeasurementJobControlSink.body-param" - description: "tapi.eth.EthProActiveMeasurementJobControlSink to be added or\ - \ updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSink" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.EthProActiveMeasurementJobControlSink" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-pro-active-1way-measurement-job/pro-active-control-1way-source/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthProActiveMeasurementJobControlSource" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthProActiveMeasurementJobControlSource" - schema: - $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.EthProActiveMeasurementJobControlSource" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthProActiveMeasurementJobControlSource.body-param" - description: "tapi.eth.EthProActiveMeasurementJobControlSource to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.EthProActiveMeasurementJobControlSource" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthProActiveMeasurementJobControlSource.body-param" - description: "tapi.eth.EthProActiveMeasurementJobControlSource to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.EthProActiveMeasurementJobControlSource" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-pro-active-2way-measurement-job/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthProActive2wayMeasurementJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthProActive2wayMeasurementJob" - schema: - $ref: "#/definitions/tapi.eth.EthProActive2wayMeasurementJob" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.EthProActive2wayMeasurementJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthProActive2wayMeasurementJob.body-param" - description: "tapi.eth.EthProActive2wayMeasurementJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthProActive2wayMeasurementJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.EthProActive2wayMeasurementJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthProActive2wayMeasurementJob.body-param" - description: "tapi.eth.EthProActive2wayMeasurementJob to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthProActive2wayMeasurementJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.EthProActive2wayMeasurementJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-pro-active-2way-measurement-job/pro-active-control-2way-source/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthProActiveMeasurementJobControlSource" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthProActiveMeasurementJobControlSource" - schema: - $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.EthProActiveMeasurementJobControlSource" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthProActiveMeasurementJobControlSource.body-param" - description: "tapi.eth.EthProActiveMeasurementJobControlSource to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.EthProActiveMeasurementJobControlSource" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthProActiveMeasurementJobControlSource.body-param" - description: "tapi.eth.EthProActiveMeasurementJobControlSource to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.EthProActiveMeasurementJobControlSource" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-test-job/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthTestJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthTestJob" - schema: - $ref: "#/definitions/tapi.eth.EthTestJob" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.EthTestJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthTestJob.body-param" - description: "tapi.eth.EthTestJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthTestJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.EthTestJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthTestJob.body-param" - description: "tapi.eth.EthTestJob to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthTestJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.EthTestJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/eth-test-job/eth-test-msg/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthOamMsgCommonPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthOamMsgCommonPac" - schema: - $ref: "#/definitions/tapi.eth.EthOamMsgCommonPac" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.EthOamMsgCommonPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthOamMsgCommonPac.body-param" - description: "tapi.eth.EthOamMsgCommonPac to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOamMsgCommonPac" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.EthOamMsgCommonPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthOamMsgCommonPac.body-param" - description: "tapi.eth.EthOamMsgCommonPac to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthOamMsgCommonPac" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.EthOamMsgCommonPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/oam-profile/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamProfileRef" - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/oam-service-end-point/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/oam-service-end-point={oam-service-uuid},{oam-service-end-point-local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - name: "oam-service-end-point-local-id" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamServiceEndPointRef" - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - name: "oam-service-end-point-local-id" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - name: "oam-service-end-point-local-id" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - name: "oam-service-end-point-local-id" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.oamjob.PmCurrentData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.oamjob.PmCurrentData" - schema: - $ref: "#/definitions/tapi.oam.oamjob.PmCurrentData" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/elapsed-time/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimeInterval" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimeInterval" - schema: - $ref: "#/definitions/tapi.common.TimeInterval" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/elapsed-time/period={unit}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "unit" - in: "path" - description: "Id of period" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-link-trace-result-data/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthLinkTraceResultData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthLinkTraceResultData" - schema: - $ref: "#/definitions/tapi.eth.EthLinkTraceResultData" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-link-trace-result-data/result-list={source-address}/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.LinkTraceResult" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "source-address" - in: "path" - description: "Id of result-list" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.LinkTraceResult" - schema: - $ref: "#/definitions/tapi.eth.LinkTraceResult" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-loopback-result-data/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthLoopbackResultData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthLoopbackResultData" - schema: - $ref: "#/definitions/tapi.eth.EthLoopbackResultData" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-on-demand-1-dm-performance-data/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthOnDemand1DmPerformanceData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthOnDemand1DmPerformanceData" - schema: - $ref: "#/definitions/tapi.eth.EthOnDemand1DmPerformanceData" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-on-demand-1-dm-performance-data/on-demand-near-end-1-dm-parameters/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.OnDemandDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.OnDemandDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.OnDemandDmPerformanceParameters" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-on-demand-1-lm-performance-data/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthOnDemand1LmPerformanceData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthOnDemand1LmPerformanceData" - schema: - $ref: "#/definitions/tapi.eth.EthOnDemand1LmPerformanceData" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-on-demand-1-lm-performance-data/on-demand-near-end-1-lm-parameters/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.OnDemandLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.OnDemandLmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.OnDemandLmPerformanceParameters" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-on-demand-dm-performance-data/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthOnDemandDmPerformanceData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthOnDemandDmPerformanceData" - schema: - $ref: "#/definitions/tapi.eth.EthOnDemandDmPerformanceData" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-on-demand-dm-performance-data/on-demand-far-end-dm-parameters/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.OnDemandDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.OnDemandDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.OnDemandDmPerformanceParameters" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-on-demand-dm-performance-data/on-demand-near-end-dm-parameters/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.OnDemandDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.OnDemandDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.OnDemandDmPerformanceParameters" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-on-demand-lm-performance-data/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthOnDemandLmPerformanceData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthOnDemandLmPerformanceData" - schema: - $ref: "#/definitions/tapi.eth.EthOnDemandLmPerformanceData" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-on-demand-lm-performance-data/on-demand-far-end-lm-parameters/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.OnDemandLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.OnDemandLmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.OnDemandLmPerformanceParameters" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-on-demand-lm-performance-data/on-demand-near-end-lm-parameters/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.OnDemandLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.OnDemandLmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.OnDemandLmPerformanceParameters" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-pro-active-1-dm-performance-data/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthProActive1DmPerformanceData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthProActive1DmPerformanceData" - schema: - $ref: "#/definitions/tapi.eth.EthProActive1DmPerformanceData" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-pro-active-1-dm-performance-data/pro-active-near-end-1-dm-parameters/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-pro-active-1-lm-performance-data/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthProActive1LmPerformanceData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthProActive1LmPerformanceData" - schema: - $ref: "#/definitions/tapi.eth.EthProActive1LmPerformanceData" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-pro-active-1-lm-performance-data/pro-active-near-end-1-lm-parameters/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalLmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-pro-active-dm-performance-data/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthProActiveDmPerformanceData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthProActiveDmPerformanceData" - schema: - $ref: "#/definitions/tapi.eth.EthProActiveDmPerformanceData" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-pro-active-dm-performance-data/pro-active-bi-dir-dm-parameters/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-pro-active-dm-performance-data/pro-active-far-end-dm-parameters/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-pro-active-dm-performance-data/pro-active-near-end-dm-parameters/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-pro-active-lm-performance-data/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthProActiveLmPerformanceData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthProActiveLmPerformanceData" - schema: - $ref: "#/definitions/tapi.eth.EthProActiveLmPerformanceData" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-pro-active-lm-performance-data/pro-active-far-end-lm-parameters/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalLmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-pro-active-lm-performance-data/pro-active-near-end-lm-parameters/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalLmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/eth-test-result-data/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthTestResultData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthTestResultData" - schema: - $ref: "#/definitions/tapi.eth.EthTestResultData" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/granularity-period/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.pmcurrentdata.PmHistoryData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.pmcurrentdata.PmHistoryData" - schema: - $ref: "#/definitions/tapi.oam.pmcurrentdata.PmHistoryData" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-on-demand-1-dm-performance-data/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthOnDemand1DmPerformanceData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthOnDemand1DmPerformanceData" - schema: - $ref: "#/definitions/tapi.eth.EthOnDemand1DmPerformanceData" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-on-demand-1-dm-performance-data/on-demand-near-end-1-dm-parameters/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.OnDemandDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.OnDemandDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.OnDemandDmPerformanceParameters" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-on-demand-1-lm-performance-data/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthOnDemand1LmPerformanceData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthOnDemand1LmPerformanceData" - schema: - $ref: "#/definitions/tapi.eth.EthOnDemand1LmPerformanceData" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-on-demand-1-lm-performance-data/on-demand-near-end-1-lm-parameters/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.OnDemandLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.OnDemandLmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.OnDemandLmPerformanceParameters" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-on-demand-dm-performance-data/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthOnDemandDmPerformanceData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthOnDemandDmPerformanceData" - schema: - $ref: "#/definitions/tapi.eth.EthOnDemandDmPerformanceData" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-on-demand-dm-performance-data/on-demand-far-end-dm-parameters/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.OnDemandDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.OnDemandDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.OnDemandDmPerformanceParameters" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-on-demand-dm-performance-data/on-demand-near-end-dm-parameters/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.OnDemandDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.OnDemandDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.OnDemandDmPerformanceParameters" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-on-demand-lm-performance-data/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthOnDemandLmPerformanceData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthOnDemandLmPerformanceData" - schema: - $ref: "#/definitions/tapi.eth.EthOnDemandLmPerformanceData" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-on-demand-lm-performance-data/on-demand-far-end-lm-parameters/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.OnDemandLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.OnDemandLmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.OnDemandLmPerformanceParameters" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-on-demand-lm-performance-data/on-demand-near-end-lm-parameters/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.OnDemandLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.OnDemandLmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.OnDemandLmPerformanceParameters" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-pro-active-1-dm-performance-data/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthProActive1DmPerformanceData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthProActive1DmPerformanceData" - schema: - $ref: "#/definitions/tapi.eth.EthProActive1DmPerformanceData" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-pro-active-1-dm-performance-data/pro-active-near-end-1-dm-parameters/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-pro-active-1-lm-performance-data/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthProActive1LmPerformanceData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthProActive1LmPerformanceData" - schema: - $ref: "#/definitions/tapi.eth.EthProActive1LmPerformanceData" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-pro-active-1-lm-performance-data/pro-active-near-end-1-lm-parameters/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalLmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-pro-active-dm-performance-data/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthProActiveDmPerformanceData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthProActiveDmPerformanceData" - schema: - $ref: "#/definitions/tapi.eth.EthProActiveDmPerformanceData" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-pro-active-dm-performance-data/pro-active-bi-dir-dm-parameters/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-pro-active-dm-performance-data/pro-active-far-end-dm-parameters/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-pro-active-dm-performance-data/pro-active-near-end-dm-parameters/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-pro-active-lm-performance-data/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthProActiveLmPerformanceData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthProActiveLmPerformanceData" - schema: - $ref: "#/definitions/tapi.eth.EthProActiveLmPerformanceData" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-pro-active-lm-performance-data/pro-active-far-end-lm-parameters/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalLmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/eth-pro-active-lm-performance-data/pro-active-near-end-lm-parameters/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalLmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/granularity-period/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/name={value-name}/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/schedule/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimeRange" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimeRange" - schema: - $ref: "#/definitions/tapi.common.TimeRange" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.TimeRange" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.TimeRange" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.TimeRange" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.TimeRange" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.TimeRange" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.oamcontext.OamProfile" - parameters: - - in: "body" - name: "tapi.oam.oamcontext.OamProfile.body-param" - description: "tapi.oam.oamcontext.OamProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.oamcontext.OamProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.oamcontext.OamProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.oamcontext.OamProfile" - schema: - $ref: "#/definitions/tapi.oam.oamcontext.OamProfile" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.oamcontext.OamProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.oam.oamcontext.OamProfile.body-param" - description: "tapi.oam.oamcontext.OamProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.oamcontext.OamProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.oamcontext.OamProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.oam.oamcontext.OamProfile.body-param" - description: "tapi.oam.oamcontext.OamProfile to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.oamcontext.OamProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.oamcontext.OamProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.PmBinData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmBinData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.PmBinData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.PmBinData" - schema: - $ref: "#/definitions/tapi.oam.PmBinData" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.PmBinData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmBinData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.PmBinData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmBinData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.PmBinData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/granularity-period/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.oamprofile.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.oam.oamprofile.PmThresholdData.body-param" - description: "tapi.oam.oamprofile.PmThresholdData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.oamprofile.PmThresholdData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.oamprofile.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.oamprofile.PmThresholdData" - schema: - $ref: "#/definitions/tapi.oam.oamprofile.PmThresholdData" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.oamprofile.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.oam.oamprofile.PmThresholdData.body-param" - description: "tapi.oam.oamprofile.PmThresholdData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.oamprofile.PmThresholdData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.oamprofile.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.oam.oamprofile.PmThresholdData.body-param" - description: "tapi.oam.oamprofile.PmThresholdData to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.oamprofile.PmThresholdData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.oamprofile.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-1-dm-threshold-data/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.Eth1DmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.Eth1DmThresholdData" - schema: - $ref: "#/definitions/tapi.eth.Eth1DmThresholdData" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.Eth1DmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.Eth1DmThresholdData.body-param" - description: "tapi.eth.Eth1DmThresholdData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.Eth1DmThresholdData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.Eth1DmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.Eth1DmThresholdData.body-param" - description: "tapi.eth.Eth1DmThresholdData to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.Eth1DmThresholdData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.Eth1DmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-1-dm-threshold-data/near-end-1-dm-clear-threshold/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-1-dm-threshold-data/near-end-1-dm-cross-threshold/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-1-lm-threshold-data/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.Eth1LmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.Eth1LmThresholdData" - schema: - $ref: "#/definitions/tapi.eth.Eth1LmThresholdData" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.Eth1LmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.Eth1LmThresholdData.body-param" - description: "tapi.eth.Eth1LmThresholdData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.Eth1LmThresholdData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.Eth1LmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.Eth1LmThresholdData.body-param" - description: "tapi.eth.Eth1LmThresholdData to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.Eth1LmThresholdData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.Eth1LmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-1-lm-threshold-data/near-end-1-lm-clear-threshold/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalLmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.StatisticalLmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalLmPerformanceParameters to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.StatisticalLmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalLmPerformanceParameters to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-1-lm-threshold-data/near-end-1-lm-cross-threshold/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalLmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.StatisticalLmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalLmPerformanceParameters to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.StatisticalLmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalLmPerformanceParameters to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-dm-threshold-data/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthDmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthDmThresholdData" - schema: - $ref: "#/definitions/tapi.eth.EthDmThresholdData" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.EthDmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthDmThresholdData.body-param" - description: "tapi.eth.EthDmThresholdData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthDmThresholdData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.EthDmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthDmThresholdData.body-param" - description: "tapi.eth.EthDmThresholdData to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthDmThresholdData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.EthDmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-dm-threshold-data/bi-dir-dm-clear-threshold/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-dm-threshold-data/bi-dir-dm-cross-threshold/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-dm-threshold-data/far-end-dm-clear-threshold/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-dm-threshold-data/far-end-dm-cross-threshold/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-dm-threshold-data/near-end-dm-clear-threshold/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-dm-threshold-data/near-end-dm-cross-threshold/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalDmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.StatisticalDmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalDmPerformanceParameters to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.StatisticalDmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-lm-threshold-data/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthLmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthLmThresholdData" - schema: - $ref: "#/definitions/tapi.eth.EthLmThresholdData" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.EthLmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthLmThresholdData.body-param" - description: "tapi.eth.EthLmThresholdData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthLmThresholdData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.EthLmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.EthLmThresholdData.body-param" - description: "tapi.eth.EthLmThresholdData to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.EthLmThresholdData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.EthLmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-lm-threshold-data/far-end-lm-clear-threshold/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalLmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.StatisticalLmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalLmPerformanceParameters to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.StatisticalLmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalLmPerformanceParameters to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-lm-threshold-data/far-end-lm-cross-threshold/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalLmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.StatisticalLmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalLmPerformanceParameters to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.StatisticalLmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalLmPerformanceParameters to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-lm-threshold-data/near-end-lm-clear-threshold/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalLmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.StatisticalLmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalLmPerformanceParameters to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.StatisticalLmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalLmPerformanceParameters to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/eth-lm-threshold-data/near-end-lm-cross-threshold/: - get: - tags: - - "tapi-eth" - description: "returns tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.StatisticalLmPerformanceParameters" - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - 400: - description: "Internal error" - post: - tags: - - "tapi-eth" - description: "creates tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.StatisticalLmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalLmPerformanceParameters to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-eth" - description: "creates or updates tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.eth.StatisticalLmPerformanceParameters.body-param" - description: "tapi.eth.StatisticalLmPerformanceParameters to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-eth" - description: "removes tapi.eth.StatisticalLmPerformanceParameters" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/granularity-period/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamService" - parameters: - - in: "body" - name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamService" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamService" - schema: - $ref: "#/definitions/tapi.oam.OamService" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamService" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamService" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamService" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamServiceEndPoint" - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/connectivity-service-end-point/: - get: - tags: - - "tapi-oam" - description: "returns tapi.connectivity.ConnectivityServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.connectivity.ConnectivityServiceEndPointRef" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.connectivity.ConnectivityServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.connectivity.ConnectivityServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/mep/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MepRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MepRef" - schema: - $ref: "#/definitions/tapi.oam.MepRef" - 400: - description: "Internal error" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/mip/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MipRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MipRef" - schema: - $ref: "#/definitions/tapi.oam.MipRef" - 400: - description: "Internal error" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/service-interface-point/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePointRef.body-param" - description: "tapi.common.ServiceInterfacePointRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePointRef.body-param" - description: "tapi.common.ServiceInterfacePointRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/meg/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MegRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MegRef" - schema: - $ref: "#/definitions/tapi.oam.MegRef" - 400: - description: "Internal error" - /data/context/oam-context/oam-service={uuid}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/oam-profile/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamProfileRef" - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathComputationContext" - parameters: [] - responses: - 200: - description: "tapi.path.computation.PathComputationContext" - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationContext" - parameters: - - in: "body" - name: "tapi.path.computation.PathComputationContext.body-param" - description: "tapi.path.computation.PathComputationContext to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathComputationContext" - parameters: - - in: "body" - name: "tapi.path.computation.PathComputationContext.body-param" - description: "tapi.path.computation.PathComputationContext to be added or\ - \ updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathComputationContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationService" - parameters: - - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathComputationService" - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - 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.PathComputationService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - 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.PathServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathServiceEndPoint" - schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.Capacity" - 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.Capacity" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.Capacity" - 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.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.Capacity" - 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.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.BandwidthProfile" - 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.BandwidthProfile" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/total-size/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/service-interface-point/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathObjectiveFunction" - schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathObjectiveFunction.body-param" - description: "tapi.path.computation.PathObjectiveFunction to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathObjectiveFunction.body-param" - description: "tapi.path.computation.PathObjectiveFunction to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathOptimizationConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathOptimizationConstraint.body-param" - description: "tapi.path.computation.PathOptimizationConstraint to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathOptimizationConstraint.body-param" - description: "tapi.path.computation.PathOptimizationConstraint to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.RoutingConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.RoutingConstraint.body-param" - description: "tapi.path.computation.RoutingConstraint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.RoutingConstraint.body-param" - description: "tapi.path.computation.RoutingConstraint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.TopologyConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.TopologyConstraint.body-param" - description: "tapi.path.computation.TopologyConstraint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.TopologyConstraint.body-param" - description: "tapi.path.computation.TopologyConstraint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/avoid-topology={topology-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of avoid-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of exclude-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of include-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-topology={topology-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.Path" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.Path" - schema: - $ref: "#/definitions/tapi.path.computation.Path" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.RoutingConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/service-interface-point/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePoint" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/available-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/total-potential-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyContext" - parameters: [] - responses: - 200: - description: "tapi.topology.TopologyContext" - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-topology" - description: "creates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.context.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-topology" - description: "creates or updates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.context.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-topology" - description: "removes tapi.topology.TopologyContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/topology-context/nw-topology-service/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NetworkTopologyService" - parameters: [] - responses: - 200: - description: "tapi.topology.NetworkTopologyService" - schema: - $ref: "#/definitions/tapi.topology.NetworkTopologyService" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "topology-uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Topology" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Topology" - schema: - $ref: "#/definitions/tapi.topology.Topology" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Link" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Link" - schema: - $ref: "#/definitions/tapi.topology.Link" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/resilience-type/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ValidationMechanism" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "validation-mechanism" - in: "path" - description: "Id of validation-mechanism" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ValidationMechanism" - schema: - $ref: "#/definitions/tapi.topology.ValidationMechanism" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.topology.Node" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.topology.Node" - schema: - $ref: "#/definitions/tapi.topology.topology.Node" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroup" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroup" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-rule-group-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroupRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.InterRuleGroup" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.InterRuleGroup" - schema: - $ref: "#/definitions/tapi.topology.InterRuleGroup" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-rule-group-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroupRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Rule" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Rule" - schema: - $ref: "#/definitions/tapi.topology.Rule" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Rule" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Rule" - schema: - $ref: "#/definitions/tapi.topology.Rule" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.node.OwnedNodeEdgePoint" - parameters: - - name: "uuid" - 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.OwnedNodeEdgePoint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - 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.context.topologycontext.topology.node.ownednodeedgepoint.CepList" - schema: - $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ceplist.ConnectionEndPoint" - parameters: - - name: "uuid" - 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.ceplist.ConnectionEndPoint" - schema: - $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/aggregated-connection-end-point={topology-uuid},{aggregated-connection-end-point-node-uuid},{node-edge-point-uuid},{aggregated-connection-end-point-connection-end-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" - parameters: - - name: "uuid" - 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.ConnectionEndPointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/client-node-edge-point={topology-uuid},{client-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - 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.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthConnectionEndPointSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthConnectionEndPointSpec" - schema: - $ref: "#/definitions/tapi.eth.EthConnectionEndPointSpec" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthCtpPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthCtpPac" - schema: - $ref: "#/definitions/tapi.eth.EthCtpPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/filter-config/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.ControlFrameFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.ControlFrameFilter" - schema: - $ref: "#/definitions/tapi.eth.ControlFrameFilter" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/traffic-conditioning/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.TrafficConditioningPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.TrafficConditioningPac" - schema: - $ref: "#/definitions/tapi.eth.TrafficConditioningPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/traffic-conditioning/cond-config-list={queue-id}/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.TrafficConditioningConfiguration" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "queue-id" - in: "path" - description: "Id of cond-config-list" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.eth.TrafficConditioningConfiguration" - schema: - $ref: "#/definitions/tapi.eth.TrafficConditioningConfiguration" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/traffic-conditioning/prio-config-list={queue-id}/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.PriorityConfiguration" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "queue-id" - in: "path" - description: "Id of prio-config-list" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.eth.PriorityConfiguration" - schema: - $ref: "#/definitions/tapi.eth.PriorityConfiguration" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/traffic-shaping/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.TrafficShapingPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.TrafficShapingPac" - schema: - $ref: "#/definitions/tapi.eth.TrafficShapingPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/traffic-shaping/prio-config-list={queue-id}/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.PriorityConfiguration" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "queue-id" - in: "path" - description: "Id of prio-config-list" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.eth.PriorityConfiguration" - schema: - $ref: "#/definitions/tapi.eth.PriorityConfiguration" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/traffic-shaping/queue-config-list={queue-id}/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.QueueConfiguration" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "queue-id" - in: "path" - description: "Id of queue-config-list" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.eth.QueueConfiguration" - schema: - $ref: "#/definitions/tapi.eth.QueueConfiguration" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-term/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EthTerminationPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EthTerminationPac" - schema: - $ref: "#/definitions/tapi.eth.EthTerminationPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-term/priority-regenerate/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.PriorityMapping" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.PriorityMapping" - schema: - $ref: "#/definitions/tapi.eth.PriorityMapping" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/ety-term/ - : get: - tags: - - "tapi-eth" - description: "returns tapi.eth.EtyTerminationPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.eth.EtyTerminationPac" - schema: - $ref: "#/definitions/tapi.eth.EtyTerminationPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MepMipList" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MepMipList" - schema: - $ref: "#/definitions/tapi.oam.MepMipList" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mep={meg-uuid},{mep-local-id}/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MepRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "meg-uuid" - in: "path" - description: "Id of mep" - required: true - type: "string" - - name: "mep-local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MepRef" - schema: - $ref: "#/definitions/tapi.oam.MepRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mip={meg-uuid},{mip-local-id}/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MipRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "meg-uuid" - in: "path" - description: "Id of mip" - required: true - type: "string" - - name: "mip-local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MipRef" - schema: - $ref: "#/definitions/tapi.oam.MipRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/name={value-name}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/parent-node-edge-point/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "service-interface-point-uuid" - in: "path" - description: "Id of mapped-service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /operations/compute-p-2-p-path/: - post: - tags: - - "tapi-path-computation" - parameters: - - in: "body" - name: "tapi.path.computation.computep2ppath.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.path.computation.computep2ppath.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.path.computation.ComputeP2PPath" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-connectivity-service/: - post: - tags: - - "tapi-connectivity" - parameters: - - in: "body" - name: "tapi.connectivity.createconnectivityservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.connectivity.createconnectivityservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.connectivity.CreateConnectivityService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-notification-subscription-service/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.CreateNotificationSubscriptionService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-oam-job/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.createoamjob.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.createoamjob.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.CreateOamJob" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-oam-service-end-point/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.createoamserviceendpoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.createoamserviceendpoint.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.CreateOamServiceEndPoint" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-oam-service/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.createoamservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.createoamservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.CreateOamService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/delete-connectivity-service/: - post: - tags: - - "tapi-connectivity" - 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/delete-notification-subscription-service/: - post: - tags: - - "tapi-notification" - 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/delete-oam-job/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.deleteoamjob.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.deleteoamjob.Input" - responses: - 201: - description: "No response" - 400: - description: "Internal error" - /operations/delete-oam-service-end-point/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.deleteoamserviceendpoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.deleteoamserviceendpoint.Input" - responses: - 201: - description: "No response" - 400: - description: "Internal error" - /operations/delete-oam-service/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.deleteoamservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.deleteoamservice.Input" - responses: - 201: - description: "No response" - 400: - description: "Internal error" - /operations/delete-p-2-p-path/: - post: - tags: - - "tapi-path-computation" - 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/get-connection-details/: - post: - tags: - - "tapi-connectivity" - 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/get-connection-end-point-details/: - post: - tags: - - "tapi-connectivity" - 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/get-connectivity-service-details/: - post: - tags: - - "tapi-connectivity" - 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/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/get-link-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.getlinkdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.getlinkdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetLinkDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-meg/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.getmeg.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.getmeg.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.GetMeg" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-node-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.getnodedetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.getnodedetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetNodeDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-node-edge-point-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.getnodeedgepointdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetNodeEdgePointDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-list/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.getnotificationlist.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.getnotificationlist.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-subscription-service-details/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-subscription-service-list/: - post: - tags: - - "tapi-notification" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-oam-job/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.getoamjob.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.getoamjob.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.GetOamJob" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-oam-service-end-point/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.getoamserviceendpoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.getoamserviceendpoint.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.GetOamServiceEndPoint" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-oam-service-list/: - post: - tags: - - "tapi-oam" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.GetOamServiceList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-oam-service/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.getoamservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.getoamservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.GetOamService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-service-interface-point-details/: - post: - tags: - - "tapi-common" - parameters: - - in: "body" - name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.common.GetServiceInterfacePointDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-service-interface-point-list/: - post: - tags: - - "tapi-common" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.common.GetServiceInterfacePointList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-supported-notification-types/: - post: - tags: - - "tapi-notification" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetSupportedNotificationTypes" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-topology-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.gettopologydetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.gettopologydetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetTopologyDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-topology-list/: - post: - tags: - - "tapi-topology" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetTopologyList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/optimize-p-2-p-path/: - post: - tags: - - "tapi-path-computation" - 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/update-connectivity-service/: - post: - tags: - - "tapi-connectivity" - 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/update-notification-subscription-service/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.UpdateNotificationSubscriptionService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-oam-job/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.updateoamjob.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.updateoamjob.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.UpdateOamJob" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-oam-service-end-point/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.updateoamserviceendpoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.updateoamserviceendpoint.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.UpdateOamServiceEndPoint" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-oam-service/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.updateoamservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.updateoamservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.UpdateOamService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-service-interface-point/: - post: - tags: - - "tapi-common" - parameters: - - in: "body" - name: "tapi.common.updateserviceinterfacepoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.common.updateserviceinterfacepoint.Input" - responses: - 201: - description: "No response" - 400: - description: "Internal error" -definitions: - tapi.common.AdminStatePac: - type: "object" - properties: - operational-state: - description: "none" - $ref: "#/definitions/tapi.common.OperationalState" - lifecycle-state: - description: "none" - $ref: "#/definitions/tapi.common.LifecycleState" - administrative-state: - description: "none" - $ref: "#/definitions/tapi.common.AdministrativeState" - tapi.common.AdministrativeState: - type: "string" - enum: - - "LOCKED" - - "UNLOCKED" - tapi.common.BandwidthProfile: - type: "object" - properties: - committed-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - coupling-flag: - type: "boolean" - description: "none" - default: false - bw-profile-type: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfileType" - peak-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - committed-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - peak-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - color-aware: - type: "boolean" - description: "none" - default: false - tapi.common.BandwidthProfileType: - type: "string" - enum: - - "MEF_10.x" - - "RFC_2697" - - "RFC_2698" - - "RFC_4115" - tapi.common.Capacity: - type: "object" - properties: - bandwidth-profile: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfile" - total-size: - description: "Total capacity of the TopologicalEntity in MB/s. In case of\ - \ bandwidthProfile, this is expected to same as the committedInformationRate." - $ref: "#/definitions/tapi.common.CapacityValue" - tapi.common.CapacityPac: - type: "object" - properties: - available-capacity: - description: "Capacity available to be assigned." - $ref: "#/definitions/tapi.common.Capacity" - total-potential-capacity: - description: "An optimistic view of the capacity of the TopologicalEntity\ - \ assuming that any shared capacity is available to be taken." - $ref: "#/definitions/tapi.common.Capacity" - tapi.common.CapacityUnit: - type: "string" - enum: - - "TB" - - "TBPS" - - "GB" - - "GBPS" - - "MB" - - "MBPS" - - "KB" - - "KBPS" - - "GHz" - - "MHz" - tapi.common.CapacityValue: - type: "object" - properties: - value: - type: "integer" - format: "int32" - description: "none" - unit: - description: "none" - $ref: "#/definitions/tapi.common.CapacityUnit" - tapi.common.Context: - allOf: - - $ref: "#/definitions/tapi.common.TapiContext" - - $ref: "#/definitions/tapi.connectivity.ContextAugmentation4" - - $ref: "#/definitions/tapi.notification.ContextAugmentation1" - - $ref: "#/definitions/tapi.oam.ContextAugmentation2" - - $ref: "#/definitions/tapi.path.computation.ContextAugmentation3" - - $ref: "#/definitions/tapi.topology.ContextAugmentation5" - 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.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" - description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ - \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ - \ circuit and packet forms." - tapi.common.ServiceInterfacePointRef: - type: "object" - properties: - service-interface-point-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-common:service-interface-point/tapi-common:uuid" - tapi.common.TapiContext: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - service-interface-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - description: "The Network Control Domain (NCD) object class represents the scope\ - \ of control that a particular SDN controller has with respect to a particular\ - \ network, (i.e., encompassing a designated set of interconnected (virtual)\ - \ network elements)." - tapi.common.TerminationDirection: - type: "string" - enum: - - "BIDIRECTIONAL" - - "SINK" - - "SOURCE" - - "UNDEFINED_OR_UNKNOWN" - tapi.common.TerminationPac: - type: "object" - properties: - termination-direction: - description: "The overall directionality of the LP. \r\n \ - \ - A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ - \ - A SINK LP can only contain elements with SINK flows\ - \ or CONTRA_DIRECTION_SOURCE flows\r\n - A SOURCE LP\ - \ can only contain SOURCE flows or CONTRA_DIRECTION_SINK flows" - $ref: "#/definitions/tapi.common.TerminationDirection" - termination-state: - description: "Indicates whether the layer is terminated and if so how." - $ref: "#/definitions/tapi.common.TerminationState" - tapi.common.TerminationState: - type: "string" - enum: - - "LP_CAN_NEVER_TERMINATE" - - "LT_NOT_TERMINATED" - - "TERMINATED_SERVER_TO_CLIENT_FLOW" - - "TERMINATED_CLIENT_TO_SERVER_FLOW" - - "TERMINATED_BIDIRECTIONAL" - - "LT_PERMENANTLY_TERMINATED" - - "TERMINATION_STATE_UNKNOWN" - tapi.common.TimeInterval: - type: "object" - properties: - period: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.TimePeriod" - tapi.common.TimePeriod: - type: "object" - properties: - value: - type: "integer" - format: "int32" - description: "none" - unit: - description: "none" - $ref: "#/definitions/tapi.common.TimeUnit" - tapi.common.TimeRange: - type: "object" - properties: - end-time: - type: "string" - description: "none" - start-time: - type: "string" - description: "none" - tapi.common.TimeUnit: - type: "string" - enum: - - "YEARS" - - "MONTHS" - - "DAYS" - - "HOURS" - - "MINUTES" - - "SECONDS" - - "MILLISECONDS" - - "MICROSECONDS" - - "NANOSECONDS" - - "PICOSECONDS" - 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.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" - 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" - 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.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.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" - 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" - coroute-inclusion: - description: "none" - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" - tapi.connectivity.ConnectivityContext: - type: "object" - properties: - connectivity-service: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ConnectivityService" - connection: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.Connection" - tapi.connectivity.ConnectivityService: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" - - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - - type: "object" - properties: - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" - connection: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ConnectionRef" - description: "The ForwardingConstruct (FC) object class models enabled potential\ - \ for forwarding between two or more LTPs and like the LTP supports any transport\ - \ protocol including all circuit and packet forms.\r\n At the\ - \ lowest level of recursion, a FC represents a cross-connection within an\ - \ NE." - tapi.connectivity.ConnectivityServiceEndPoint: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $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" - 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" - 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.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.ContextAugmentation4: - 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.context.topologycontext.topology.node.ownednodeedgepoint.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.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" - description: "The FC Route (FcRoute) object class models the individual routes\ - \ of an FC. \r\n The route of an FC object is represented by\ - \ a list of FCs at a lower level. \r\n Note that depending\ - \ on the service supported by an FC, an the FC can have multiple routes." - 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.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.UpdateConnectivityService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.connectivity.updateconnectivityservice.Output" - tapi.connectivity.ceplist.ConnectionEndPoint: - allOf: - - $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" - - $ref: "#/definitions/tapi.eth.ConnectionEndPointAugmentation1" - - $ref: "#/definitions/tapi.oam.ConnectionEndPointAugmentation2" - tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList: - allOf: - - type: "object" - properties: - connection-end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" - description: "none" - 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.eth.BandwidthReport: - type: "object" - properties: - port-id: - type: "integer" - format: "int32" - description: "This attribute returns the far end port identifier." - source-mac-address: - type: "string" - description: "The sourceMacAddress is the address from the far end." - current-bandwidth: - type: "integer" - format: "int32" - description: "This attribute returns the current bandwidth." - nominal-bandwidth: - type: "integer" - format: "int32" - description: "This attribute returns the configured bandwidth" - tapi.eth.ColourMode: - type: "string" - enum: - - "COLOUR_BLIND" - - "COLOUR_AWARE" - tapi.eth.ConnectionEndPointAugmentation1: - type: "object" - properties: - eth-connection-end-point-spec: - description: "Augments the base LayerProtocol information in ConnectionEndPoint\ - \ with ETH-specific information" - $ref: "#/definitions/tapi.eth.EthConnectionEndPointSpec" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.ControlFrameFilter: - type: "object" - properties: - c-2-00-00-2-a: - type: "boolean" - description: "Reserved for future standardization." - default: false - c-2-00-00-0-c: - type: "boolean" - description: "Reserved for future standardization." - default: false - c-2-00-00-0-b: - type: "boolean" - description: "Reserved for future standardization." - default: false - c-2-00-00-2-c: - type: "boolean" - description: "Reserved for future standardization." - default: false - c-2-00-00-0-e: - type: "boolean" - description: "This attribute identifies the Individual LAN Scope group address,\ - \ Nearest Bridge group address (LLDP protocol)." - default: false - c-2-00-00-2-b: - type: "boolean" - description: "Reserved for future standardization." - default: false - c-2-00-00-0-d: - type: "boolean" - description: "This attribute identifies the Provider Bridge MVRP address." - default: false - c-2-00-00-2-e: - type: "boolean" - description: "Reserved for future standardization." - default: false - c-2-00-00-2-d: - type: "boolean" - description: "Reserved for future standardization." - default: false - c-2-00-00-0-f: - type: "boolean" - description: "Reserved for future standardization." - default: false - c-2-00-00-2-f: - type: "boolean" - description: "Reserved for future standardization." - default: false - c-2-00-00-10: - type: "boolean" - description: "This attribute identifies the 'All LANs Bridge Management Group\ - \ Address'." - default: false - c-2-00-00-09: - type: "boolean" - description: "Reserved for future standardization." - default: false - c-2-00-00-29: - type: "boolean" - description: "Reserved for future standardization." - default: false - c-2-00-00-07: - type: "boolean" - description: "This attribute identifies the Metro Ethernet Forum E-LMI protocol\ - \ group address." - default: false - c-2-00-00-08: - type: "boolean" - description: "This attribute identifies the Provider Bridge Group address." - default: false - c-2-00-00-27: - type: "boolean" - description: "Reserved for future standardization." - default: false - c-2-00-00-05: - type: "boolean" - description: "Reserved for future standardization." - default: false - c-2-00-00-28: - type: "boolean" - description: "Reserved for future standardization." - default: false - c-2-00-00-06: - type: "boolean" - description: "Reserved for future standardization." - default: false - c-2-00-00-25: - type: "boolean" - description: "Reserved for future standardization." - default: false - c-2-00-00-03: - type: "boolean" - description: "This attribute identifies the Nearest non-TPMR Bridge group\ - \ address (Port Authentication protocol)." - default: false - c-2-00-00-26: - type: "boolean" - description: "Reserved for future standardization." - default: false - c-2-00-00-04: - type: "boolean" - description: "This attribute identifies the IEEE MAC-specific Control Protocols\ - \ group address." - default: false - c-2-00-00-23: - type: "boolean" - description: "Reserved for future standardization." - default: false - c-2-00-00-01: - type: "boolean" - description: "This attribute identifies the IEEE MAC-specific Control Protocols\ - \ group address (PAUSE protocol)." - default: false - c-2-00-00-24: - type: "boolean" - description: "Reserved for future standardization." - default: false - c-2-00-00-02: - type: "boolean" - description: "This attribute identifies the IEEE 802.3 Slow_Protocols_Multicast\ - \ address (LACP/LAMP or Link OAM protocols)." - default: false - c-2-00-00-21: - type: "boolean" - description: "This attribute identifies the Customer Bridge MVRP address." - default: false - c-2-00-00-22: - type: "boolean" - description: "Reserved for future standardization." - default: false - c-2-00-00-00: - type: "boolean" - description: "This attribute identifies the STP/RSTP/MSTP protocol address." - default: false - c-2-00-00-20: - type: "boolean" - description: "This attribute identifies the Customer and Provider Bridge MMRP\ - \ address." - default: false - c-2-00-00-0-a: - type: "boolean" - description: "Reserved for future standardization." - default: false - tapi.eth.CsfConfig: - type: "string" - enum: - - "DISABLED" - - "ENABLED" - - "ENABLED_WITH_RDI_FDI" - - "ENABLED_WITH_RDI_FDI_DCI" - - "ENABLED_WITH_DCI" - tapi.eth.Eth1DmThresholdData: - type: "object" - properties: - near-end-1-dm-cross-threshold: - description: "This attribute contains the near end cross threshold values\ - \ of the delay measurements." - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - near-end-1-dm-clear-threshold: - description: "This attribute contains the near end clear threshold values\ - \ of the delay measurements." - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - tapi.eth.Eth1LmThresholdData: - type: "object" - properties: - near-end-1-lm-cross-threshold: - description: "This attribute contains the near end cross threshold values\ - \ of the loss measurements." - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - near-end-1-lm-clear-threshold: - description: "This attribute is only valid for frame loss ratio parameters\ - \ and counter type parameters working in the 'standing condition method'\ - \ (see G.7710, section 10.1.7.2: Threshold reporting) and contains the near\ - \ end clear threshold values of the loss measurements." - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - tapi.eth.EthConnectionEndPointSpec: - type: "object" - properties: - eth-term: - description: "none" - $ref: "#/definitions/tapi.eth.EthTerminationPac" - ety-term: - description: "none" - $ref: "#/definitions/tapi.eth.EtyTerminationPac" - eth-ctp: - description: "none" - $ref: "#/definitions/tapi.eth.EthCtpPac" - tapi.eth.EthCtpPac: - type: "object" - properties: - csf-rdi-fdi-enable: - type: "boolean" - description: "This attribute models the MI_CSFrdifdiEnable information defined\ - \ in G.8021." - default: false - vlan-config: - type: "integer" - format: "int32" - description: "This attribute models the ETHx/ETH-m_A_So_MI_Vlan_Config information\ - \ defined in G.8021.\r\n range of type : -1, 0, 1..4094" - filter-config: - description: "This attribute models the FilterConfig MI defined in section\ - \ 8.3/G.8021. It indicates the configured filter action for each of the\ - \ 33 group MAC addresses for control frames. The 33 MAC addresses are:\r\ - \n - All bridges address: 01-80-C2-00-00-10,\r\n \ - \ - Reserved addresses: 01-80-C2-00-00-00 to 01-80-C2-00-00-0F,\r\ - \n - GARP Application addresses: 01-80-C2-00-00-20 to\ - \ 01-80-C2-00-00-2F.\r\n The filter action is Pass or\ - \ Block. \r\n If the destination address of the incoming\ - \ ETH_CI_D matches one of the above addresses, the filter process shall\ - \ perform the corresponding configured filter action. \r\n \ - \ If none of the above addresses match, the ETH_CI_D is passed." - $ref: "#/definitions/tapi.eth.ControlFrameFilter" - mac-length: - type: "integer" - format: "int32" - description: "This attribute models the MAC_Lenght MI defined in 8.6/G.8021\ - \ for the MAC Length Check process. It indicates the allowed maximum frame\ - \ length in bytes.\r\n range of type : 1518, 1522, 2000" - default: 2000 - csf-report: - type: "boolean" - description: "This attribute models the MI_CSF_Reported information defined\ - \ in G.8021.\r\n range of type : true, false" - default: false - filter-config-snk: - type: "array" - description: "This attribute models the FilteConfig MI defined in 8.3/G.8021.\ - \ It indicates the configured filter action for each of the 33 group MAC\ - \ addresses for control frames. The 33 MAC addresses are:\r\n \ - \ 01-80-C2-00-00-10, \r\n 01-80-C2-00-00-00\ - \ to 01-80-C2-00-00-0F, and \r\n 01-80-C2-00-00-20 to\ - \ 01-80-C2-00-00-2F.\r\n The filter action is Pass or\ - \ Block. \r\n If the destination address of the incoming\ - \ ETH_CI_D matches one of the above addresses, the filter process shall\ - \ perform the corresponding configured filter action. \r\n \ - \ If none of the above addresses match, the ETH_CI_D is passed." - items: - type: "string" - pll-thr: - type: "integer" - format: "int32" - description: "This attribute provisions the threshold for the number of active\ - \ ports. If the number of active ports is more than zero but less than the\ - \ provisioned threshold, a cPLL (Partial Link Loss) is raised. See section\ - \ 9.7.1.2 of G.8021.\r\n range of type : 0..number of\ - \ ports" - csf-config: - description: "This attribute models the combination of all CSF related MI\ - \ signals (MI_CSF_Enable, MI_CSFrdifdi_Enable, MI_CSFdci_Enable) as defined\ - \ in G.8021.\r\n range of type : true, false" - $ref: "#/definitions/tapi.eth.CsfConfig" - partner-system-id: - type: "string" - description: "See 802.1AX:\r\n A MAC address consisting\ - \ of the unique identifier for the current protocol Partner of this Aggregator.\ - \ A value of zero indicates that there is no known Partner. If the aggregation\ - \ is manually configured, this System ID value will be a value assigned\ - \ by the local System." - partner-system-priority: - type: "integer" - format: "int32" - description: "See 802.1AX:\r\n Indicates the priority associated\ - \ with the Partners System ID. If the aggregation is manually configured,\ - \ this System Priority value will be a value assigned by the local System.\r\ - \n range of type : 2-octet" - partner-oper-key: - type: "integer" - format: "int32" - description: "See 802.1AX:\r\n The current operational\ - \ value of the Key for the Aggregators current protocol Partner. If the\ - \ aggregation is manually configured, this Key value will be a value assigned\ - \ by the local System.\r\n range of type : 16-bit" - traffic-conditioning: - description: "none" - $ref: "#/definitions/tapi.eth.TrafficConditioningPac" - actor-system-priority: - type: "integer" - format: "int32" - description: "See 802.1AX:\r\n Indicating the priority\ - \ associated with the Actors System ID.\r\n range of\ - \ type : 2-octet" - actor-oper-key: - type: "integer" - format: "int32" - description: "See 802.1AX:\r\n The current operational\ - \ value of the Key for the Aggregator. The administrative Key value may\ - \ differ from the operational Key value for the reasons discussed in 5.6.2.\r\ - \n The meaning of particular Key values is of local significance.\r\ - \n range of type : 16 bit" - collector-max-delay: - type: "integer" - format: "int32" - description: "See 802.1AX:\r\n The value of this attribute\ - \ defines the maximum delay, in tens of microseconds, that may be imposed\ - \ by the Frame Collector between receiving a frame from an Aggregator Parser,\ - \ and either delivering the frame to its MAC Client or discarding the frame\ - \ (see IEEE 802.1AX clause 5.2.3.1.1).\r\n range of type\ - \ : 16-bit" - is-ssf-reported: - type: "boolean" - description: "This attribute provisions whether the SSF defect should be reported\ - \ as fault cause or not.\r\n It models the ETH-LAG_FT_Sk_MI_SSF_Reported\ - \ defined in G.8021." - default: false - data-rate: - type: "integer" - format: "int32" - description: "See 802.1AX:\r\n The current data rate, in\ - \ bits per second, of the aggregate link. The value is calculated as N times\ - \ the data rate of a single link in the aggregation, where N is the number\ - \ of active links." - traffic-shaping: - description: "none" - $ref: "#/definitions/tapi.eth.TrafficShapingPac" - actor-system-id: - type: "string" - description: "See 802.1AX:\r\n A MAC address used as a\ - \ unique identifier for the System that contains this Aggregator." - auxiliary-function-position-sequence: - type: "array" - description: "This attribute indicates the positions (i.e., the relative order)\ - \ of all the MEP, MIP, and TCS objects which are associated with the CTP." - items: - type: "integer" - format: "int32" - tapi.eth.EthDmThresholdData: - type: "object" - properties: - bi-dir-dm-clear-threshold: - description: "This attribute contains the bidirectional clear threshold values\ - \ of the delay measurements." - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - near-end-dm-cross-threshold: - description: "This attribute contains the near end cross threshold values\ - \ of the delay measurements." - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - far-end-dm-clear-threshold: - description: "This attribute contains the far end clear threshold values of\ - \ the delay measurements." - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - far-end-dm-cross-threshold: - description: "This attribute contains the far end cross threshold values of\ - \ the delay measurements." - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - bi-dir-dm-cross-threshold: - description: "This attribute contains the bidirectional cross threshold values\ - \ of the delay measurements." - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - near-end-dm-clear-threshold: - description: "This attribute contains the near end clear threshold values\ - \ of the delay measurements." - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - tapi.eth.EthLinkTraceJob: - type: "object" - properties: - time-to-live: - type: "integer" - format: "int32" - description: "G.8052: This parameter provides the Time To Live (TTL) parameter\ - \ of the Link Track protocol.\r\n The TTL parameter allows\ - \ the receiver (MIP or MEP) of the LTM frame to determine if the frame can\ - \ be terminated. TTL is decremented every time the LTM frame is relayed.\ - \ LTM frame with TTL<=1 is terminated and not relayed." - eth-lt-msg: - description: "none" - $ref: "#/definitions/tapi.eth.EthOamOperationCommonPac" - tapi.eth.EthLinkTraceResultData: - type: "object" - properties: - result-list: - type: "array" - description: "G.8052: This parameter returns the results of the LT process.\ - \ It contains a list of the result received from the individual LTR frames.\r\ - \n The result from the individual LTR frame include the\ - \ Source Mac Address, the TTL, and TLV." - items: - $ref: "#/definitions/tapi.eth.LinkTraceResult" - tapi.eth.EthLmThresholdData: - type: "object" - properties: - far-end-lm-clear-threshold: - description: "This attribute is only valid for frame loss ratio parameters\ - \ and counter type parameters working in the 'standing condition method'\ - \ (see G.7710, section 10.1.7.2: Threshold reporting) and contains the far\ - \ end clear threshold values of the loss measurements." - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - far-end-lm-cross-threshold: - description: "This attribute contains the far end cross threshold values of\ - \ the loss measurements." - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - near-end-lm-clear-threshold: - description: "This attribute is only valid for frame loss ratio parameters\ - \ and counter type parameters working in the 'standing condition method'\ - \ (see G.7710, section 10.1.7.2: Threshold reporting) and contains the near\ - \ end clear threshold values of the loss measurements." - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - bi-dir-lm-uas-cross-threshold: - type: "integer" - format: "int32" - description: "This attribute contains the bidirectional cross threshold value\ - \ of the UAS loss measurement." - bi-dir-lm-uas-clear-threshold: - type: "integer" - format: "int32" - description: "This attribute is only valid for the UAS parameter working in\ - \ the 'standing condition method' (see G.7710, section 10.1.7.2: Threshold\ - \ reporting) and contains the bidirectional clear threshold value of the\ - \ UAS loss measurement." - near-end-lm-cross-threshold: - description: "This attribute contains the near end cross threshold values\ - \ of the loss measurements." - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - tapi.eth.EthLoopbackJob: - type: "object" - properties: - number: - type: "integer" - format: "int32" - description: "G.8052: This parameter specifies how many LB messages to be\ - \ sent for the LB_Series process." - eth-lb-msg: - description: "none" - $ref: "#/definitions/tapi.eth.EthOamMsgCommonPac" - tapi.eth.EthLoopbackResultData: - type: "object" - properties: - ber-lbr-frames: - type: "integer" - format: "int32" - description: "G.8052: This parameter returns the number of LBR frames where\ - \ there was a bit error in the pattern." - crc-lbr-frames: - type: "integer" - format: "int32" - description: "G.8052: This parameter returns the number of LBR frames where\ - \ the CRC in the pattern failed." - detected-peer-mep: - type: "array" - description: "G.8052: This parameter returns the MAC addresses of the discovered\ - \ peer MEPs of the subject MEP." - items: - type: "string" - sent-lbm-frames: - type: "integer" - format: "int32" - description: "G.8052: This parameter returns the total number of sent LBM\ - \ frames." - out-of-order-lbr-frames: - type: "integer" - format: "int32" - description: "G.8052: This parameter returns the number of LBR traffic unites\ - \ (messages) that were received out of order (OO)." - rec-lbr-frames: - type: "integer" - format: "int32" - description: "G.8052: This parameter returns the total number of received\ - \ LBR messages, including the out of order LBR frames." - tapi.eth.EthMegSpec: - type: "object" - properties: - client-mel: - type: "integer" - format: "int32" - description: "none" - tapi.eth.EthMepCommon: - type: "object" - properties: - lck-period: - description: "This attribute models the MI_LCK_Period signal defined in G.8021\ - \ and configured as specified in G8051. It is the frequency at which the\ - \ LCK messages should be sent.\r\n range of type : 1s,\ - \ 1min" - $ref: "#/definitions/tapi.eth.OamPeriod" - cc-priority: - type: "integer" - format: "int32" - description: "This attribute models the MI_CC_Pri signal defined in G.8021\ - \ and configured as specified in G8051. It is the priority at which the\ - \ CCM message should be sent." - default: 7 - is-cc-enabled: - type: "boolean" - description: "This attribute models the MI_CC_Enable signal defined in G.8021\ - \ and configured as specified in G8051." - default: false - lck-priority: - type: "integer" - format: "int32" - description: "This attribute models the MI_LCK_Pri signal defined in G.8021\ - \ and configured as specified in G8051. It is the priority at which the\ - \ LCK messages should be sent." - default: 7 - cc-period: - description: "This attribute models the MI_CC_Period signal defined in G.8021\ - \ and configured as specified in G8051. \r\n It is the\ - \ period at which the CCM message should be sent. \r\n \ - \ Default values are: 3.33 ms for PS, 100 ms for PM, 1 s for FM." - $ref: "#/definitions/tapi.eth.OamPeriod" - mep-mac: - type: "string" - description: "This attribute contains the MAC Address of the MEP." - tapi.eth.EthMepSink: - type: "object" - properties: - dm-1-priority: - type: "array" - description: "This attribute indicates the list of 1DM priorities for the\ - \ MepSink." - items: - type: "integer" - format: "int32" - lm-m: - type: "integer" - format: "int32" - description: "This attribute defines the number of consecutive good seconds\ - \ necessary for the clearing of 'degraded'. See also section 'Degraded signal\ - \ defect (dDEG)' in G.8021." - default: 10 - is-csf-reported: - type: "boolean" - description: "This attribute models the MI_CSF_Reported signal defined in\ - \ G.8021 and configured as specified in G8051. It configures whether the\ - \ secondary failure CSF should be reported or not." - default: true - lm-deg-thr: - type: "integer" - format: "int32" - description: "This attribute defines the threshold for declaring a 'bad second'.\ - \ See also section 'Degraded signal defect (dDEG)' in G.8021." - default: 30 - bandwidth-report: - description: "This attribute models the content of the bandwidth report received\ - \ by the MEP Sink from the peer MEP Source." - $ref: "#/definitions/tapi.eth.BandwidthReport" - lm-degm: - type: "integer" - format: "int32" - description: "This attribute defines the number of consecutive bad seconds\ - \ necessary for the 'degraded' detection. See also section 'Degraded signal\ - \ defect (dDEG)' in G.8021." - default: 10 - is-csf-rdi-fdi-enabled: - type: "boolean" - description: "This attribute models the MI_CSFrdifdiEnable signal defined\ - \ in G.8021 and configured as specified in G8051." - default: true - ais-period: - description: "This attribute models the MI_AIS_Period signal defined in G.8021\ - \ and configured as specified in G8051. It is the frequency at which the\ - \ AIS messages should be sent.\r\n range of type : 1s,\ - \ 1min" - $ref: "#/definitions/tapi.eth.OamPeriod" - ais-priority: - type: "integer" - format: "int32" - description: "This attribute models the MI_AIS_Pri signal defined in G.8021\ - \ and configured as specified in G8051. It is the priority at which the\ - \ AIS messages should be sent." - default: 7 - lm-tf-min: - type: "integer" - format: "int32" - description: "This attribute defines the necessary number of transmitted frames\ - \ to enable the detection of 'bad seconds'. See also section 'Degraded signal\ - \ defect (dDEG)' in G.8021." - tapi.eth.EthMepSource: - type: "object" - properties: - csf-period: - description: "This attribute models the MI_CSF_Period signal defined in G.8021\ - \ and configured as specified in G8051. It is the period at which the CSF\ - \ messages should be sent.\r\n range of type : 1s, 1min" - $ref: "#/definitions/tapi.eth.OamPeriod" - csf-priority: - type: "integer" - format: "int32" - description: "This attribute models the MI_CSF_Pri signal defined in G.8021\ - \ and configured as specified in G8051. It is the priority at which the\ - \ CSF messages should be sent" - default: 7 - csf-config: - description: "This attribute models the combination of all CSF related MI\ - \ signals (MI_CSF_Enable, MI_CSFrdifdi_Enable, MI_CSFdci_Enable) as defined\ - \ in G.8021." - $ref: "#/definitions/tapi.eth.CsfConfig" - aps-priority: - type: "integer" - format: "int32" - description: "This attribute specifies the priority of the APS messages.\r\ - \n See section 8.1.5 APS insert process in G.8021." - default: 7 - tapi.eth.EthMepSpec: - type: "object" - properties: - eth-mep-common: - description: "none" - $ref: "#/definitions/tapi.eth.EthMepCommon" - eth-mep-sink: - description: "none" - $ref: "#/definitions/tapi.eth.EthMepSink" - eth-mep-source-pac: - description: "none" - $ref: "#/definitions/tapi.eth.EthMepSource" - tapi.eth.EthMipSpec: - type: "object" - properties: - mip-mac: - type: "string" - description: "This attribute contains the MAC address of the MIP instance." - is-full-mip: - type: "boolean" - description: "This attribute indicates whether the MIP is a full MIP (true)\ - \ or a down-half MIP (false)." - default: false - tapi.eth.EthOamMsgCommonPac: - allOf: - - $ref: "#/definitions/tapi.eth.EthOamOperationCommonPac" - - type: "object" - properties: - data-tlv-length: - type: "integer" - format: "int32" - description: "G.8052: This parameter provides the length (in number of octet)\ - \ of the optional Data TLV to be included in the TST frame." - test-pattern: - type: "integer" - format: "int32" - description: "G.8052: This parameter provides the test pattern to be used\ - \ in the optional Data TLV.\r\n Examples of test patterns\ - \ include pseudo-random bit sequence (PRBS) 2^31-1 as specified in clause\ - \ 5.8 of [ITU-T O.150], all '0' pattern, etc.\r\n The\ - \ following values of pattern types are defined:\r\n \ - \ 0: 'Null signal without CRC-32'\r\n 1: 'Null signal\ - \ with CRC-32'\r\n 2: 'PRBS 2^31-1 without CRC-32'\r\ - \n 3: 'PRBS 2^31-1 with CRC-32'." - period: - description: "G.8052: This parameter provides the periodicity of the TST\ - \ OAM messages." - $ref: "#/definitions/tapi.eth.OamPeriod" - drop-eligibility: - type: "boolean" - description: "G.8052: This parameter provides the eligibility of frames\ - \ with unicast ETH-TST information to be discarded when congestion conditions\ - \ are encountered." - default: false - description: "none" - tapi.eth.EthOamOperationCommonPac: - type: "object" - properties: - priority: - type: "integer" - format: "int32" - description: "G.8052: This parameter provides the priority to be used in the\ - \ LBM frame." - default: 7 - destination-address: - type: "string" - description: "G.8052: This parameter provides the destination address, i.e.,\ - \ the MAC Address of the target MEP or MIP." - tapi.eth.EthOnDemand1DmPerformanceData: - type: "object" - properties: - on-demand-near-end-1-dm-parameters: - description: "This attribute contains the results of an on-demand frame delay\ - \ measurement job in the ingress direction." - $ref: "#/definitions/tapi.eth.OnDemandDmPerformanceParameters" - tapi.eth.EthOnDemand1LmPerformanceData: - type: "object" - properties: - on-demand-near-end-1-lm-parameters: - description: "This attribute contains the results of an on-demand synthetic\ - \ loss measurement job in the ingress direction." - $ref: "#/definitions/tapi.eth.OnDemandLmPerformanceParameters" - tapi.eth.EthOnDemand1wayMeasurementJob: - type: "object" - properties: - on-demand-control-1way-source: - description: "none" - $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" - on-demand-control-1way-sink: - description: "none" - $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSink" - tapi.eth.EthOnDemand2wayMeasurementJob: - type: "object" - properties: - on-demand-control-2way-source: - description: "none" - $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" - tapi.eth.EthOnDemandDmPerformanceData: - type: "object" - properties: - on-demand-far-end-dm-parameters: - description: "This attribute contains the results of an on-demand frame delay\ - \ measurement job in the ingress direction." - $ref: "#/definitions/tapi.eth.OnDemandDmPerformanceParameters" - on-demand-near-end-dm-parameters: - description: "This attribute contains the results of an on-demand frame delay\ - \ measurement job in the ingress direction." - $ref: "#/definitions/tapi.eth.OnDemandDmPerformanceParameters" - tapi.eth.EthOnDemandLmPerformanceData: - type: "object" - properties: - on-demand-far-end-lm-parameters: - description: "This attribute contains the results of an on-demand synthetic\ - \ loss measurement job in the egress direction." - $ref: "#/definitions/tapi.eth.OnDemandLmPerformanceParameters" - on-demand-near-end-lm-parameters: - description: "This attribute contains the results of an on-demand synthetic\ - \ loss measurement job in the ingress direction." - $ref: "#/definitions/tapi.eth.OnDemandLmPerformanceParameters" - tapi.eth.EthOnDemandMeasurementJobControlSink: - type: "object" - properties: - priority: - type: "integer" - format: "int32" - description: "This attribute contains the priority of the OAM PDU frames.\r\ - \n range of type : 0, 1, 2, 3, 4, 5, 6, 7" - default: 7 - responder-mep-id: - type: "string" - description: "none" - source-address: - type: "string" - description: "This attribute contains the MAC address of the peer MEP. See\ - \ G.8013 for details." - test-identifier: - type: "integer" - format: "int32" - description: "This attribute is used to distinguish each measurement session\ - \ if multiple measurement sessions are simultaneously activated towards\ - \ a peer MEP including concurrent on-demand and proactive tests. It must\ - \ be unique at least within the context of any measurement type for the\ - \ MEG and initiating MEP.\r\n range of type : 0..(2^32)\ - \ - 1" - tapi.eth.EthOnDemandMeasurementJobControlSource: - type: "object" - properties: - data-tlv-length: - type: "integer" - format: "int32" - description: "This parameter provides the size of the optional data TLV.\r\ - \n Non-negative integer represents the number of bytes\ - \ for the length of the padding TLV.\r\n Notes:\r\n \ - \ When configuring this parameter one should be aware\ - \ of the maximum allowed total frame size limitation.\r\n \ - \ The attribute is not used in case of 2-way loss measurement.\r\n\ - \ range of type : Depends on the allowed MTU size." - test-identifier: - type: "integer" - format: "int32" - description: "This attribute is used to distinguish each measurement session\ - \ if multiple measurement sessions are simultaneously activated towards\ - \ a peer MEP including concurrent on-demand and proactive tests. It must\ - \ be unique at least within the context of any measurement type for the\ - \ MEG and initiating MEP.\r\n Note: The attribute is\ - \ not used in case of LMM/LMR measurement.\r\n range\ - \ of type : 0..(2^32) - 1" - repetition-period: - description: "This attribute contains the time between the start of two measurement\ - \ intervals. This IS applicable for the repetitive instance type and MAY\ - \ be applicable for the repetitive series type. \r\n \ - \ Note that a value of 0 means not applicable (NA), which is for the cases\ - \ of single instance, single series, or repetitive series without extra\ - \ gap in between the measurement intervals (i.e., also as known as continuous\ - \ series)." - $ref: "#/definitions/tapi.eth.RepetitionPeriod" - destination-address: - type: "string" - description: "This attribute contains the MAC address of the peer MEP. See\ - \ G.8013 for details." - oam-pdu-generation-type: - description: "This attribute contains the pattern that is used for the generation\ - \ of OAM PDUs." - $ref: "#/definitions/tapi.eth.OamPduGenerationType" - priority: - type: "integer" - format: "int32" - description: "This attribute contains the priority of the OAM PDU frames.\r\ - \n range of type : 0, 1, 2, 3, 4, 5, 6, 7" - default: 7 - message-period: - description: "This attribute contains the frequency of the OAM message (PDU)\ - \ generation within a series. \r\n Note that the value\ - \ 0 means that only one OAM message per measurement interval is generated.\r\ - \n range of type : See corresponding Enum." - $ref: "#/definitions/tapi.eth.MessagePeriod" - controller-mep-id: - type: "string" - description: "none" - measurement-interval: - type: "integer" - format: "int32" - description: "This attribute contains the discrete non overlapping periods\ - \ of time (in seconds) during which measurements are performed (i.e., OAM\ - \ messages are generated) and reports are gathered at the end of the measurement\ - \ intervals. Note that the value 0 means a degenerated measurement interval\ - \ with a single OAM message and the report is sent as immediately as possible.\r\ - \n range of type : Non-negative" - tapi.eth.EthProActive1DmPerformanceData: - type: "object" - properties: - pro-active-near-end-1-dm-parameters: - description: "This attribute contains the statistical near end performnace\ - \ parameters." - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - tapi.eth.EthProActive1LmPerformanceData: - type: "object" - properties: - pro-active-near-end-1-lm-parameters: - description: "This attribute contains the statistical near end performnace\ - \ parameters." - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - tapi.eth.EthProActive1wayMeasurementJob: - type: "object" - properties: - pro-active-control-1way-source: - description: "none" - $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" - pro-active-control-1way-sink: - description: "none" - $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSink" - tapi.eth.EthProActive2wayMeasurementJob: - type: "object" - properties: - pro-active-control-2way-source: - description: "none" - $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" - tapi.eth.EthProActiveDmPerformanceData: - type: "object" - properties: - pro-active-bi-dir-dm-parameters: - description: "This attribute contains the statistical bidirectional performnace\ - \ parameters." - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - pro-active-far-end-dm-parameters: - description: "This attribute contains the statistical far end performnace\ - \ parameters." - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - pro-active-near-end-dm-parameters: - description: "This attribute contains the statistical near end performnace\ - \ parameters." - $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" - tapi.eth.EthProActiveLmPerformanceData: - type: "object" - properties: - bidirectional-uas: - type: "integer" - format: "int32" - description: "This attribute contains the bidirectional UAS (unavailable seconds)\ - \ detected in the monitoring interval.\r\n range of type\ - \ : 0..900 for 15min interval or 0..86400 for 24 hr interval." - pro-active-far-end-lm-parameters: - description: "This attribute contains the statistical far end performnace\ - \ parameters." - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - pro-active-near-end-lm-parameters: - description: "This attribute contains the statistical near end performnace\ - \ parameters." - $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" - tapi.eth.EthProActiveMeasurementJobControlSink: - type: "object" - properties: - responder-mep-id: - type: "string" - description: "none" - source-address: - type: "string" - description: "This attribute contains the MAC address of the peer MEP. See\ - \ G.8013 for details." - test-identifier: - type: "integer" - format: "int32" - description: "This attribute is used to distinguish each measurement session\ - \ if multiple measurement sessions are simultaneously activated towards\ - \ a peer MEP including concurrent on-demand and proactive tests. It must\ - \ be unique at least within the context of any measurement type for the\ - \ MEG and initiating MEP.\r\n range of type : 0..(2^32)\ - \ - 1" - is-enabled: - type: "boolean" - description: "This attribute identifies the state of the measurement job.\ - \ If set to TRUE, the MEP performs proactive Performance Measurement." - default: true - tapi.eth.EthProActiveMeasurementJobControlSource: - type: "object" - properties: - data-tlv-length: - type: "integer" - format: "int32" - description: "This parameter provides the size of the optional data TLV.\r\ - \n Non-negative integer represents the number of bytes\ - \ for the length of the padding TLV.\r\n Notes:\r\n \ - \ When configuring this parameter one should be aware\ - \ of the maximum allowed total frame size limitation.\r\n \ - \ The attribute is not used in case of 2-way loss measurement.\r\n\ - \ range of type : Depends on the allowed MTU size." - period: - description: "This attribute indicates the period (frequency) of the measurement\ - \ frame transmission.\r\n range of type : 100ms, 1s,\ - \ 10s" - $ref: "#/definitions/tapi.eth.OamPeriod" - test-identifier: - type: "integer" - format: "int32" - description: "This attribute is used to distinguish each measurement session\ - \ if multiple measurement sessions are simultaneously activated towards\ - \ a peer MEP including concurrent on-demand and proactive tests. It must\ - \ be unique at least within the context of any measurement type for the\ - \ MEG and initiating MEP.\r\n Note: The attribute is\ - \ not used in case of 2-way loss measurement. \r\n range\ - \ of type : 0..(2^32) - 1" - destination-address: - type: "string" - description: "This attribute provides the Unicast MAC address of the intented\ - \ destination." - priority: - type: "integer" - format: "int32" - description: "This attribute contains the priority value on which the MEP\ - \ performs the measurement. When the measurement is enabled, the MEP should\ - \ use this value to encode the priority of generated measurement frames.\ - \ The EMF usese this value to assign the P parameter of the measurement\ - \ operation." - default: 7 - controller-mep-id: - type: "string" - description: "none" - is-enabled: - type: "boolean" - description: "This attribute identifies the state of the measurement job.\ - \ If set to TRUE, the MEP performs proactive Performance Measurement." - default: true - tapi.eth.EthTerminationPac: - type: "object" - properties: - filter-config-1: - type: "array" - description: "This attribute models the ETHx/ETH-m_A_Sk_MI_Filter_Config information\ - \ defined in G.8021.\r\n It indicates the configured\ - \ filter action for each of the 33 group MAC addresses for control frames.\r\ - \n The 33 MAC addresses are:\r\n 01-80-C2-00-00-10,\ - \ \r\n 01-80-C2-00-00-00 to 01-80-C2-00-00-0F, and \r\ - \n 01-80-C2-00-00-20 to 01-80-C2-00-00-2F.\r\n \ - \ The filter action is Pass or Block. \r\n \ - \ If the destination address of the incoming ETH_CI_D matches one of\ - \ the above addresses, the filter process shall perform the corresponding\ - \ configured filter action. \r\n If none of the above\ - \ addresses match, the ETH_CI_D is passed.\r\n range\ - \ of type : MacAddress: \r\n 01-80-C2-00-00-10, \r\n\ - \ 01-80-C2-00-00-00 to \r\n 01-80-C2-00-00-0F,\ - \ and \r\n 01-80-C2-00-00-20 to \r\n \ - \ 01-80-C2-00-00-2F;\r\n ActionEnum:\r\n \ - \ PASS, BLOCK" - items: - type: "string" - ether-type: - description: "This attribute models the ETHx/ETH-m _A_Sk_MI_Etype information\ - \ defined in G.8021." - $ref: "#/definitions/tapi.eth.VlanType" - priority-code-point-config: - description: "This attribute models the ETHx/ETH-m _A_Sk_MI_PCP_Config information\ - \ defined in G.8021.\r\n range of type : see Enumeration" - $ref: "#/definitions/tapi.eth.PcpCoding" - frametype-config: - description: "This attribute models the ETHx/ETH-m_A_Sk_MI_Frametype_Config\ - \ information defined in G.8021.\r\n range of type :\ - \ see Enumeration" - $ref: "#/definitions/tapi.eth.FrameType" - port-vid: - type: "string" - description: "This attribute models the ETHx/ETH-m _A_Sk_MI_PVID information\ - \ defined in G.8021." - default: "1" - priority-regenerate: - description: "This attribute models the ETHx/ETH-m _A_Sk_MI_P_Regenerate information\ - \ defined in G.8021." - $ref: "#/definitions/tapi.eth.PriorityMapping" - tapi.eth.EthTestJob: - type: "object" - properties: - eth-test-msg: - description: "none" - $ref: "#/definitions/tapi.eth.EthOamMsgCommonPac" - tapi.eth.EthTestResultData: - type: "object" - properties: - sent-tst-frames: - type: "integer" - format: "int32" - description: "G.8052: This parameter returns the total number of sent TST\ - \ frames." - tapi.eth.EtyPhyType: - type: "string" - enum: - - "OTHER" - - "UNKNOWN" - - "NONE" - - "2BASE_TL" - - "10MBIT_S" - - "10PASS_TS" - - "100BASE_T4" - - "100BASE_X" - - "100BASE_T2" - - "1000BASE_X" - - "1000BASE_T" - - "10GBASE-X" - - "10GBASE_R" - - "10GBASE_W" - tapi.eth.EtyTerminationPac: - type: "object" - properties: - phy-type: - description: "This attribute identifies the PHY type of the ETY trail termination.\ - \ See IEEE 802.3 clause 30.3.2.1.2." - $ref: "#/definitions/tapi.eth.EtyPhyType" - is-fts-enabled: - type: "boolean" - description: "This attribute indicates whether Forced Transmitter Shutdown\ - \ (FTS) is enabled or not. It models the ETYn_TT_So_MI_FTSEnable information." - default: false - is-tx-pause-enabled: - type: "boolean" - description: "This attribute identifies whether the Transmit Pause process\ - \ is enabled or not. It models the MI_TxPauseEnable defined in G.8021." - default: false - phy-type-list: - type: "array" - description: "This attribute identifies the possible PHY types that could\ - \ be supported at the ETY trail termination. See IEEE 802.3 clause 30.3.2.1.3." - items: - $ref: "#/definitions/tapi.eth.EtyPhyType" - tapi.eth.FrameType: - type: "string" - enum: - - "ADMIT_ONLY_VLAN_TAGGED_FRAMES" - - "ADMIT_ONLY_UNTAGGED_AND_PRIORITY_TAGGED_FRAMES" - - "ADMIT_ALL_FRAMES" - tapi.eth.LinkTraceResult: - type: "object" - properties: - data-tlv-length: - type: "integer" - format: "int32" - description: "G.8052: This attribute contains the length (in number of octets)\ - \ of the Data TLV of an individual LTR frame result." - time-to-live: - type: "integer" - format: "int32" - description: "G.8052: This attribute contains the Time To Live (TTL) value\ - \ of an individual LTR frame result." - source-address: - type: "string" - description: "G.8052: This attribute contains the source MAC Address of an\ - \ individual LTR frame result." - tapi.eth.MegAugmentation1: - type: "object" - properties: - eth-meg-spec: - description: "none" - $ref: "#/definitions/tapi.eth.EthMegSpec" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.MepAugmentation1: - type: "object" - properties: - eth-mep-spec: - description: "none" - $ref: "#/definitions/tapi.eth.EthMepSpec" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.MessagePeriod: - type: "string" - enum: - - "10MS" - - "100MS" - - "1S" - - "10S" - - "0" - tapi.eth.MipAugmentation1: - type: "object" - properties: - eth-mip-spec: - description: "none" - $ref: "#/definitions/tapi.eth.EthMipSpec" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.OamJobAugmentation1: - type: "object" - properties: - eth-loopback-job: - description: "none" - $ref: "#/definitions/tapi.eth.EthLoopbackJob" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.OamJobAugmentation2: - type: "object" - properties: - eth-on-demand-2way-measurement-job: - description: "none" - $ref: "#/definitions/tapi.eth.EthOnDemand2wayMeasurementJob" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.OamJobAugmentation3: - type: "object" - properties: - eth-on-demand-1way-measurement-job: - description: "none" - $ref: "#/definitions/tapi.eth.EthOnDemand1wayMeasurementJob" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.OamJobAugmentation4: - type: "object" - properties: - eth-pro-active-2way-measurement-job: - description: "none" - $ref: "#/definitions/tapi.eth.EthProActive2wayMeasurementJob" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.OamJobAugmentation5: - type: "object" - properties: - eth-pro-active-1way-measurement-job: - description: "none" - $ref: "#/definitions/tapi.eth.EthProActive1wayMeasurementJob" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.OamJobAugmentation6: - type: "object" - properties: - eth-link-trace-job: - description: "none" - $ref: "#/definitions/tapi.eth.EthLinkTraceJob" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.OamJobAugmentation7: - type: "object" - properties: - eth-test-job: - description: "none" - $ref: "#/definitions/tapi.eth.EthTestJob" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.OamPduGenerationType: - type: "string" - enum: - - "SINGLE_INSTANCE" - - "REPETITIVE_INSTANCE" - - "SINGLE_SERIES" - - "REPETITIVE_SERIES" - tapi.eth.OamPeriod: - type: "string" - enum: - - "3_33MS" - - "10MS" - - "100MS" - - "1S" - - "10S" - - "1MIN" - - "10MIN" - tapi.eth.OnDemandDmPerformanceParameters: - type: "object" - properties: - frame-delay-variation-list: - type: "array" - description: "This attribute contains the frame delay variations measured\ - \ in ns (nano second). The multiplicity is defined by (numberOfSamples\ - \ - 1, for numberOfSamples > 0)." - items: - type: "integer" - format: "int32" - number-of-samples: - type: "integer" - format: "int32" - description: "This attribute contains the number of received DM frames (successful\ - \ samples) used for this frame delay measurement.\r\n \ - \ range of type : non-negative" - frame-delay-list: - type: "array" - description: "This attribute contains the frame delays measured in ns (nano\ - \ second, 1x10e-9 seconds). The multiplicity is defined by the numberOfSamples\ - \ attribute." - items: - type: "integer" - format: "int32" - tapi.eth.OnDemandLmPerformanceParameters: - type: "object" - properties: - total-transmitted-frames: - type: "integer" - format: "int32" - description: "This attribute contains the total number of frames transmitted." - total-frame-loss-ratio: - type: "string" - description: "This attribute contains the frame loss ratio (number of lost\ - \ frames divided by the number of total frames (N_LF / N_TF)).\r\n \ - \ The accuracy of the value is for further study." - total-lost-frames: - type: "integer" - format: "int32" - description: "This attribute contains the total number of frames lost." - tapi.eth.PcpCoding: - type: "string" - enum: - - "8P0D" - - "7P1D" - - "6P2D" - - "5P3D" - - "DEI" - tapi.eth.PmCurrentDataAugmentation1: - type: "object" - properties: - eth-loopback-result-data: - description: "none" - $ref: "#/definitions/tapi.eth.EthLoopbackResultData" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmCurrentDataAugmentation10: - type: "object" - properties: - eth-on-demand-dm-performance-data: - description: "none" - $ref: "#/definitions/tapi.eth.EthOnDemandDmPerformanceData" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmCurrentDataAugmentation11: - type: "object" - properties: - eth-pro-active-1-dm-performance-data: - description: "none" - $ref: "#/definitions/tapi.eth.EthProActive1DmPerformanceData" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmCurrentDataAugmentation2: - type: "object" - properties: - eth-link-trace-result-data: - description: "none" - $ref: "#/definitions/tapi.eth.EthLinkTraceResultData" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmCurrentDataAugmentation3: - type: "object" - properties: - eth-test-result-data: - description: "none" - $ref: "#/definitions/tapi.eth.EthTestResultData" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmCurrentDataAugmentation4: - type: "object" - properties: - eth-on-demand-1-dm-performance-data: - description: "none" - $ref: "#/definitions/tapi.eth.EthOnDemand1DmPerformanceData" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmCurrentDataAugmentation5: - type: "object" - properties: - eth-pro-active-dm-performance-data: - description: "none" - $ref: "#/definitions/tapi.eth.EthProActiveDmPerformanceData" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmCurrentDataAugmentation6: - type: "object" - properties: - eth-on-demand-1-lm-performance-data: - description: "none" - $ref: "#/definitions/tapi.eth.EthOnDemand1LmPerformanceData" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmCurrentDataAugmentation7: - type: "object" - properties: - eth-on-demand-lm-performance-data: - description: "none" - $ref: "#/definitions/tapi.eth.EthOnDemandLmPerformanceData" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmCurrentDataAugmentation8: - type: "object" - properties: - eth-pro-active-lm-performance-data: - description: "none" - $ref: "#/definitions/tapi.eth.EthProActiveLmPerformanceData" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmCurrentDataAugmentation9: - type: "object" - properties: - eth-pro-active-1-lm-performance-data: - description: "none" - $ref: "#/definitions/tapi.eth.EthProActive1LmPerformanceData" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmHistoryDataAugmentation1: - type: "object" - properties: - eth-on-demand-dm-performance-data: - description: "none" - $ref: "#/definitions/tapi.eth.EthOnDemandDmPerformanceData" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmHistoryDataAugmentation2: - type: "object" - properties: - eth-on-demand-1-lm-performance-data: - description: "none" - $ref: "#/definitions/tapi.eth.EthOnDemand1LmPerformanceData" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmHistoryDataAugmentation3: - type: "object" - properties: - eth-pro-active-lm-performance-data: - description: "none" - $ref: "#/definitions/tapi.eth.EthProActiveLmPerformanceData" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmHistoryDataAugmentation4: - type: "object" - properties: - eth-on-demand-1-dm-performance-data: - description: "none" - $ref: "#/definitions/tapi.eth.EthOnDemand1DmPerformanceData" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmHistoryDataAugmentation5: - type: "object" - properties: - eth-pro-active-dm-performance-data: - description: "none" - $ref: "#/definitions/tapi.eth.EthProActiveDmPerformanceData" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmHistoryDataAugmentation6: - type: "object" - properties: - eth-pro-active-1-dm-performance-data: - description: "none" - $ref: "#/definitions/tapi.eth.EthProActive1DmPerformanceData" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmHistoryDataAugmentation7: - type: "object" - properties: - eth-pro-active-1-lm-performance-data: - description: "none" - $ref: "#/definitions/tapi.eth.EthProActive1LmPerformanceData" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmHistoryDataAugmentation8: - type: "object" - properties: - eth-on-demand-lm-performance-data: - description: "none" - $ref: "#/definitions/tapi.eth.EthOnDemandLmPerformanceData" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmThresholdDataAugmentation1: - type: "object" - properties: - eth-lm-threshold-data: - description: "none" - $ref: "#/definitions/tapi.eth.EthLmThresholdData" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmThresholdDataAugmentation2: - type: "object" - properties: - eth-dm-threshold-data: - description: "none" - $ref: "#/definitions/tapi.eth.EthDmThresholdData" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmThresholdDataAugmentation3: - type: "object" - properties: - eth-1-dm-threshold-data: - description: "none" - $ref: "#/definitions/tapi.eth.Eth1DmThresholdData" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PmThresholdDataAugmentation4: - type: "object" - properties: - eth-1-lm-threshold-data: - description: "none" - $ref: "#/definitions/tapi.eth.Eth1LmThresholdData" - x-augmentation: - prefix: "tapi-eth" - namespace: "urn:onf:otcc:yang:tapi-eth" - tapi.eth.PriorityConfiguration: - type: "object" - properties: - priority: - type: "integer" - format: "int32" - description: "none" - queue-id: - type: "integer" - format: "int32" - description: "none" - tapi.eth.PriorityMapping: - type: "object" - properties: - priority-0: - type: "integer" - format: "int32" - description: "This attribute defines the new priority value for the old priority\ - \ value 0." - priority-1: - type: "integer" - format: "int32" - description: "This attribute defines the new priority value for the old priority\ - \ value 1." - default: 1 - priority-2: - type: "integer" - format: "int32" - description: "This attribute defines the new priority value for the old priority\ - \ value 2." - default: 2 - priority-3: - type: "integer" - format: "int32" - description: "This attribute defines the new priority value for the old priority\ - \ value 3." - default: 3 - priority-4: - type: "integer" - format: "int32" - description: "This attribute defines the new priority value for the old priority\ - \ value 4." - default: 4 - priority-5: - type: "integer" - format: "int32" - description: "This attribute defines the new priority value for the old priority\ - \ value 5." - default: 5 - priority-6: - type: "integer" - format: "int32" - description: "This attribute defines the new priority value for the old priority\ - \ value 6." - default: 6 - priority-7: - type: "integer" - format: "int32" - description: "This attribute defines the new priority value for the old priority\ - \ value 7." - default: 7 - tapi.eth.QueueConfiguration: - type: "object" - properties: - queue-threshold: - type: "integer" - format: "int32" - description: "This attribute defines the threshold of the queue in bytes." - queue-id: - type: "integer" - format: "int32" - description: "This attribute indicates the queue id." - queue-depth: - type: "integer" - format: "int32" - description: "This attribute defines the depth of the queue in bytes." - tapi.eth.RepetitionPeriod: - type: "string" - enum: - - "1MIN" - - "1S" - - "10S" - - "0" - tapi.eth.StatisticalDmPerformanceParameters: - type: "object" - properties: - average-frame-delay: - type: "integer" - format: "int32" - description: "This attribute contains the average frame delay observed over\ - \ the monitored period. It is measured in units of ns (nano second, 1x10e-9\ - \ seconds)." - maximum-frame-delay: - type: "integer" - format: "int32" - description: "This attribute contains the maximum frame delay observed over\ - \ the monitored period. It is measured in units of ns (nano second, 1x10e-9\ - \ seconds)." - minimum-frame-delay: - type: "integer" - format: "int32" - description: "This attribute contains the minimum frame delay observed over\ - \ the monitored period. It is measured in units of ns (nano second, 1x10e-9\ - \ seconds)." - maximum-frame-delay-variation: - type: "integer" - format: "int32" - description: "This attribute contains the maximum frame delay variation measured\ - \ in units of ns (nano second, 1x10e-9 seconds)." - minimum-frame-delay-variation: - type: "integer" - format: "int32" - description: "This attribute contains the minimum frame delay variation measured\ - \ in units of ns (nano second, 1x10e-9 seconds)." - average-frame-delay-variation: - type: "integer" - format: "int32" - description: "This attribute contains the average frame delay variation measured\ - \ in units of ns (nano second, 1x10e-9 seconds)." - tapi.eth.StatisticalLmPerformanceParameters: - type: "object" - properties: - ses: - type: "integer" - format: "int32" - description: "This attribute contains the SES detected in the monitoring interval.\r\ - \n range of type : 0..900 for 15min interval or 0..86400\ - \ for 24 hr interval." - average-frame-loss-ratio: - type: "string" - description: "This attribute contains the average frame loss ratio calculated\ - \ over a period of time.\r\n The accuracy of the value\ - \ is for further study." - maximum-frame-loss-ratio: - type: "string" - description: "This attribute contains the maximum frame loss ratio calculated\ - \ over a period of time.\r\n The accuracy of the value\ - \ is for further study." - uas: - type: "integer" - format: "int32" - description: "This attribute contains UAS (unavailable seconds) detected in\ - \ the monitoring interval.\r\n range of type : 0..900\ - \ for 15min interval or 0..86400 for 24 hr interval." - minimum-frame-loss-ratio: - type: "string" - description: "This attribute contains the minimum frame loss ratio calculated\ - \ over a period of time.\r\n The accuracy of the value\ - \ is for further study." - tapi.eth.TrafficConditioningConfiguration: - type: "object" - properties: - queue-id: - type: "integer" - format: "int32" - description: "This attribute indicates the queue id." - coupling-flag: - type: "boolean" - description: "This attribute indicates the coupling flag." - default: false - cbs: - type: "integer" - format: "int32" - description: "This attribute indicates the Committed Burst Size in bytes." - ebs: - type: "integer" - format: "int32" - description: "This attribute indicates the Excess Burst Size in bytes." - colour-mode: - description: "This attribute indicates the colour mode." - $ref: "#/definitions/tapi.eth.ColourMode" - cir: - type: "integer" - format: "int32" - description: "This attribute indicates the Committed Information Rate in bits/s." - eir: - type: "integer" - format: "int32" - description: "This attribute indicates the Excess Information Rate in bits/s." - tapi.eth.TrafficConditioningPac: - type: "object" - properties: - codirectional: - type: "boolean" - description: "This attribute indicates the direction of the conditioner. The\ - \ value of true means that the conditioner (modeled as a TCS Sink according\ - \ to G.8021) is associated with the sink part of the containing CTP. The\ - \ value of false means that the conditioner (modeled as a TCS Sink according\ - \ to G.8021) is associated with the source part of the containing CTP." - default: false - prio-config-list: - type: "array" - description: "This attribute indicates the Priority Splitter function for\ - \ the mapping of the Ethernet frame priority (ETH_CI_P) values to the output\ - \ queue." - items: - $ref: "#/definitions/tapi.eth.PriorityConfiguration" - cond-config-list: - type: "array" - description: "This attribute indicates for the conditioner process the conditioning\ - \ parameters:\r\n - Queue ID: Indicates the Queue ID\r\ - \n - Committed Information Rate (CIR): number of bits\ - \ per second\r\n - Committed Burst Size (CBS): number\ - \ of bytes\r\n - Excess Information Rate (EIR): number\ - \ of bits per second\r\n - Excess Burst Size (EBS): number\ - \ of bytes\r\n - Coupling flag (CF): 0 or 1\r\n \ - \ - Color mode (CM): color-blind and color-aware." - items: - $ref: "#/definitions/tapi.eth.TrafficConditioningConfiguration" - tapi.eth.TrafficShapingPac: - type: "object" - properties: - codirectional: - type: "boolean" - description: "This attribute indicates the direction of the shaping function.\ - \ The value of true means that the shaping (modeled as a TCS Source according\ - \ to G.8021) is associated with the source part of the containing CTP. The\ - \ value of false means that the shaping (modeled as a TCS Source according\ - \ to G.8021) is associated with the sink part of the containing CTP." - default: false - sched-config: - type: "string" - description: "This attribute configures the scheduler process. The value of\ - \ this attribute is for further study because it is for further study in\ - \ G.8021.\r\n Scheduler is a pointer to a Scheduler object,\ - \ which is to be defined in the future (because in G.8021, this is FFS).\r\ - \n Note that the only significance of the GTCS function\ - \ defined in G.8021 is the use of a common scheduler for shaping. Given\ - \ that, G.8052 models the common scheduler feature by having a common value\ - \ for this attribute." - queue-config-list: - type: "array" - description: "This attribute configures the Queue depth and Dropping threshold\ - \ parameters of the Queue process. The Queue depth sets the maximum size\ - \ of the queue in bytes. An incoming ETH_CI traffic unit is dropped if there\ - \ is insufficient space in the queue to hold the whole unit. The Dropping\ - \ threshold sets the threshold of the queue. If the queue is filled beyond\ - \ this threshold, incoming ETH_CI traffic units accompanied by the ETH_CI_DE\ - \ signal set are dropped." - items: - $ref: "#/definitions/tapi.eth.QueueConfiguration" - prio-config-list: - type: "array" - description: "This attribute configures the Priority Splitter function for\ - \ the mapping of the Ethernet frame priority (ETH_CI_P) values to the output\ - \ queue." - items: - $ref: "#/definitions/tapi.eth.PriorityConfiguration" - tapi.eth.VlanType: - type: "string" - enum: - - "C_Tag" - - "S_Tag" - - "I_Tag" - tapi.notification.AlarmInfo: - type: "object" - properties: - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedSeverityType" - probable-cause: - type: "string" - description: "none" - service-affecting: - description: "none" - $ref: "#/definitions/tapi.notification.ServiceAffecting" - is-transient: - type: "boolean" - description: "none" - default: false - tapi.notification.ContextAugmentation1: - type: "object" - properties: - notification-context: - description: "Augments the base TAPI Context with NotificationService information" - $ref: "#/definitions/tapi.notification.NotificationContext" - 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.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.NotificationContext: - type: "object" - properties: - notif-subscription: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - notification: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.Notification" - tapi.notification.NotificationSubscriptionService: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - notification: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.Notification" - notification-channel: - description: "none" - $ref: "#/definitions/tapi.notification.NotificationChannel" - subscription-state: - description: "none" - $ref: "#/definitions/tapi.notification.SubscriptionState" - supported-object-types: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.ObjectType" - supported-notification-types: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.NotificationType" - subscription-filter: - description: "none" - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - description: "none" - tapi.notification.NotificationType: - type: "string" - enum: - - "OBJECT_CREATION" - - "OBJECT_DELETION" - - "ATTRIBUTE_VALUE_CHANGE" - - "ALARM_EVENT" - - "THRESHOLD_CROSSING_ALERT" - tapi.notification.ObjectType: - type: "string" - enum: - - "TOPOLOGY" - - "NODE" - - "LINK" - - "CONNECTION" - - "PATH" - - "CONNECTIVITY_SERVICE" - - "VIRTUAL_NETWORK_SERVICE" - - "PATH_COMPUTATION_SERVICE" - - "NODE_EDGE_POINT" - - "SERVICE_INTERFACE_POINT" - - "CONNECTION_END_POINT" - - "MAINTENANCE_ENTITY_GROUP" - - "MAINTENANCE_ENTITY" - - "MEG_END_POINT" - - "MEG_INTERMEDIATE_POINT" - - "SWITCH_CONTROL" - - "SWITCH" - - "ROUTE" - - "NODE_RULE_GROUP" - - "INTER_RULE_GROUP" - - "RULE" - - "OAM_JOB" - tapi.notification.PerceivedSeverityType: - type: "string" - enum: - - "CRITICAL" - - "MAJOR" - - "MINOR" - - "WARNING" - - "CLEARED" - tapi.notification.PerceivedTcaSeverity: - type: "string" - enum: - - "WARNING" - - "CLEAR" - tapi.notification.ServiceAffecting: - type: "string" - enum: - - "SERVICE_AFFECTING" - - "NOT_SERVICE_AFFECTING" - - "UNKNOWN" - 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.SubscriptionState: - type: "string" - enum: - - "SUSPENDED" - - "ACTIVE" - tapi.notification.TcaInfo: - type: "object" - properties: - threshold-crossing: - description: "none" - $ref: "#/definitions/tapi.notification.ThresholdCrossingType" - threshold-parameter: - type: "string" - description: "none" - is-transient: - type: "boolean" - description: "none" - default: false - threshold-value: - type: "integer" - format: "int32" - description: "none" - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedTcaSeverity" - suspect-interval-flag: - type: "boolean" - description: "none" - default: false - measurement-interval: - type: "string" - description: "none" - tapi.notification.ThresholdCrossingType: - type: "string" - enum: - - "THRESHOLD_ABOVE" - - "THRESHOLD_BELOW" - - "CLEARED" - tapi.notification.UpdateNotificationSubscriptionService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Output" - tapi.notification.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.oam.ConnectionEndPointAugmentation2: - type: "object" - properties: - mep-mip-list: - description: "none" - $ref: "#/definitions/tapi.oam.MepMipList" - x-augmentation: - prefix: "tapi-oam" - namespace: "urn:onf:otcc:yang:tapi-oam" - tapi.oam.ContextAugmentation2: - type: "object" - properties: - oam-context: - description: "Augments the base TAPI Context with OamService information" - $ref: "#/definitions/tapi.oam.context.OamContext" - x-augmentation: - prefix: "tapi-oam" - namespace: "urn:onf:otcc:yang:tapi-oam" - tapi.oam.CreateOamJob: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.createoamjob.Output" - tapi.oam.CreateOamService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.createoamservice.Output" - tapi.oam.CreateOamServiceEndPoint: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.createoamserviceendpoint.Output" - tapi.oam.GetMeg: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.getmeg.Output" - tapi.oam.GetOamJob: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.getoamjob.Output" - tapi.oam.GetOamService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.getoamservice.Output" - tapi.oam.GetOamServiceEndPoint: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.getoamserviceendpoint.Output" - tapi.oam.GetOamServiceList: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.getoamservicelist.Output" - tapi.oam.Meg: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.common.OperationalStatePac" - - type: "object" - properties: - meg-identifier: - type: "string" - description: "none" - meg-level: - type: "integer" - format: "int32" - description: "none" - mip: - type: "array" - description: "ME may 0, 1, or more MIPs" - items: - $ref: "#/definitions/tapi.oam.Mip" - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - mep: - type: "array" - description: "1. ME may have 0 MEPs (case of transit domains where at least\ - \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case\ - \ of edge domaind, where the peer MEP is ouside the managed domain)\r\n\ - \ 3. ME may have 2 MEPs" - items: - $ref: "#/definitions/tapi.oam.Mep" - direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" - description: "none" - tapi.oam.MegRef: - type: "object" - properties: - meg-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:uuid" - tapi.oam.Mep: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - $ref: "#/definitions/tapi.common.OperationalStatePac" - - type: "object" - properties: - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - peer-mep-identifier: - type: "array" - description: "none" - items: - type: "string" - mep-identifier: - type: "string" - description: "none" - direction: - description: "none" - $ref: "#/definitions/tapi.common.TerminationDirection" - description: "none" - tapi.oam.MepMipList: - type: "object" - properties: - mip: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.MipRef" - mep: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.MepRef" - tapi.oam.MepRef: - allOf: - - $ref: "#/definitions/tapi.oam.MegRef" - - type: "object" - properties: - mep-local-id: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:mep/tapi-oam:local-id" - description: "none" - tapi.oam.Mip: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - description: "none" - tapi.oam.MipRef: - allOf: - - $ref: "#/definitions/tapi.oam.MegRef" - - type: "object" - properties: - mip-local-id: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:mip/tapi-oam:local-id" - description: "none" - tapi.oam.OamConstraint: - type: "object" - properties: - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - meg-level: - type: "integer" - format: "int32" - description: "none" - direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" - tapi.oam.OamJob: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - schedule: - description: "none" - $ref: "#/definitions/tapi.common.TimeRange" - oam-profile: - description: "none" - $ref: "#/definitions/tapi.oam.OamProfileRef" - pm-current-data: - type: "array" - description: "Granularity period of the CurrentData identifies the specific\ - \ CurrentData instance in the scope of this OamJob.\r\n \ - \ For example, typically at least\r\n one 15min\ - \ and\r\n one 24hr;\r\n optionally\ - \ one additional configurable (< 15min)" - items: - $ref: "#/definitions/tapi.oam.PmCurrentData" - creation-time: - type: "string" - description: "none" - oam-service-end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" - oam-job-type: - type: "string" - description: "none" - description: "none" - tapi.oam.OamProfile: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - pm-threshold-data: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.PmThresholdData" - pm-bin-data: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.PmBinData" - description: "none" - tapi.oam.OamProfileRef: - type: "object" - properties: - oam-profile-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-profile/tapi-oam:uuid" - tapi.oam.OamService: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.oam.OamConstraint" - - type: "object" - properties: - oam-profile: - description: "none" - $ref: "#/definitions/tapi.oam.OamProfileRef" - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - meg: - description: "none" - $ref: "#/definitions/tapi.oam.MegRef" - description: "none" - tapi.oam.OamServiceEndPoint: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - peer-mep-identifier: - type: "array" - description: "This attribute models the MI_PeerMEP_ID[i] defined in G.8021\ - \ and configured as specified in G.8051. It provides the identifiers of\ - \ the MEPs which are peer to the subject MEP.\r\n This\ - \ attribute is not specified in case the OSEP relates to the provisioing\ - \ of an MIP.\r\n In case of P2P, there is only one\ - \ peer" - items: - type: "string" - connectivity-service-end-point: - description: "none" - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" - mip: - description: "none" - $ref: "#/definitions/tapi.oam.MipRef" - service-interface-point: - description: "none" - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - mep: - description: "none" - $ref: "#/definitions/tapi.oam.MepRef" - mep-identifier: - type: "string" - description: "This attribute contains the identifier of the MEP.\r\n \ - \ This attribute is empty in case the OSEP relates to\ - \ the provisioing of an MIP.\r\n " - direction: - description: "none" - $ref: "#/definitions/tapi.common.PortDirection" - description: "none" - tapi.oam.OamServiceEndPointRef: - allOf: - - $ref: "#/definitions/tapi.oam.OamServiceRef" - - type: "object" - properties: - oam-service-end-point-local-id: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:end-point/tapi-oam:local-id" - description: "none" - tapi.oam.OamServiceRef: - type: "object" - properties: - oam-service-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:uuid" - tapi.oam.PmBinData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - description: "none" - tapi.oam.PmCurrentData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - elapsed-time: - description: "none" - $ref: "#/definitions/tapi.common.TimeInterval" - pm-history-data: - type: "array" - description: "in case of 24hr Current Data, at least 1 History Data.\r\n\ - \ In case of 15min Current Data, at least 16 History\ - \ Data.\r\n In case of <15min, the number of History\ - \ Data shall be able to cover a span of 4 hours." - items: - $ref: "#/definitions/tapi.oam.PmHistoryData" - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - suspect-interval-flag: - type: "boolean" - description: "This attribute is used to indicate that the performance data\ - \ for the current period may not be reliable. Some reasons for this to\ - \ occur are:\r\n – Suspect data were detected by the\ - \ actual resource doing data collection.\r\n – Transition\ - \ of the administrativeState attribute to/from the 'lock' state.\r\n \ - \ – Transition of the operationalState to/from the 'disabled'\ - \ state.\r\n – Scheduler setting that inhibits the\ - \ collection function.\r\n – The performance counters\ - \ were reset during the interval.\r\n – The currentData\ - \ (or subclass) object instance was created during the monitoring period." - default: false - timestamp: - type: "string" - description: "This attribute indicates the start of the current monitoring\ - \ interval.\r\n The value is bound to the quarter of\ - \ an hour in case of a 15 minute interval and bound to the hour in case\ - \ of a 24 hour interval." - description: "none" - tapi.oam.PmHistoryData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - period-end-time: - type: "string" - description: "none" - suspect-interval-flag: - type: "boolean" - description: "This attribute indicates that the performance data may not\ - \ be reliable." - default: false - description: "none" - tapi.oam.PmThresholdData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - is-transient: - type: "boolean" - description: "none" - default: false - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - description: "none" - tapi.oam.UpdateOamJob: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.updateoamjob.Output" - tapi.oam.UpdateOamService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.updateoamservice.Output" - tapi.oam.UpdateOamServiceEndPoint: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.updateoamserviceendpoint.Output" - tapi.oam.context.OamContext: - allOf: - - type: "object" - properties: - oam-service: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamService" - oam-profile: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.oamcontext.OamProfile" - oam-job: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.oamcontext.OamJob" - meg: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.oamcontext.Meg" - description: "Augments the base TAPI Context with OamService information" - tapi.oam.createoamjob.Input: - type: "object" - properties: - schedule: - type: "string" - description: "none" - oam-service-end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - oam-job-type: - type: "string" - description: "none" - oam-profile: - description: "none" - $ref: "#/definitions/tapi.oam.OamProfile" - state: - type: "string" - description: "none" - tapi.oam.createoamjob.Output: - type: "object" - properties: - oam-job: - description: "none" - $ref: "#/definitions/tapi.oam.OamJob" - tapi.oam.createoamservice.Input: - type: "object" - properties: - oam-constraint: - description: "none" - $ref: "#/definitions/tapi.oam.OamConstraint" - state: - type: "string" - description: "none" - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.oam.createoamservice.Output: - type: "object" - properties: - service: - description: "none" - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.createoamserviceendpoint.Input: - type: "object" - properties: - peer-mep-identifier: - type: "array" - description: "none" - items: - type: "string" - service-id: - type: "string" - description: "none" - sip-id: - type: "string" - description: "none" - c-sep-id: - type: "string" - description: "none" - mep-identifier: - type: "string" - description: "none" - state: - type: "string" - description: "none" - layer: - type: "string" - description: "none" - direction: - type: "string" - description: "none" - tapi.oam.createoamserviceendpoint.Output: - type: "object" - properties: - end-point: - description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.oam.deleteoamjob.Input: - type: "object" - properties: - job-id: - type: "string" - description: "none" - tapi.oam.deleteoamservice.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - tapi.oam.deleteoamserviceendpoint.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - o-sep-id: - type: "string" - description: "none" - tapi.oam.getmeg.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - tapi.oam.getmeg.Output: - type: "object" - properties: - meg: - description: "none" - $ref: "#/definitions/tapi.oam.Meg" - tapi.oam.getoamjob.Input: - type: "object" - properties: - job-id: - type: "string" - description: "none" - tapi.oam.getoamjob.Output: - type: "object" - properties: - oam-job: - description: "none" - $ref: "#/definitions/tapi.oam.OamJob" - tapi.oam.getoamservice.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - tapi.oam.getoamservice.Output: - type: "object" - properties: - service: - description: "none" - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.getoamserviceendpoint.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - o-sep-id: - type: "string" - description: "none" - tapi.oam.getoamserviceendpoint.Output: - type: "object" - properties: - end-point: - description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.oam.getoamservicelist.Output: - type: "object" - properties: - service: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.meg.Mep: - allOf: - - $ref: "#/definitions/tapi.eth.MepAugmentation1" - - $ref: "#/definitions/tapi.oam.Mep" - tapi.oam.meg.Mip: - allOf: - - $ref: "#/definitions/tapi.eth.MipAugmentation1" - - $ref: "#/definitions/tapi.oam.Mip" - tapi.oam.oamcontext.Meg: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.common.OperationalStatePac" - - $ref: "#/definitions/tapi.eth.MegAugmentation1" - - type: "object" - properties: - meg-identifier: - type: "string" - description: "none" - meg-level: - type: "integer" - format: "int32" - description: "none" - mip: - type: "array" - description: "ME may 0, 1, or more MIPs" - items: - $ref: "#/definitions/tapi.oam.meg.Mip" - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - mep: - type: "array" - description: "1. ME may have 0 MEPs (case of transit domains where at least\ - \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case\ - \ of edge domaind, where the peer MEP is ouside the managed domain)\r\n\ - \ 3. ME may have 2 MEPs" - items: - $ref: "#/definitions/tapi.oam.meg.Mep" - direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" - description: "none" - tapi.oam.oamcontext.OamJob: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.eth.OamJobAugmentation1" - - $ref: "#/definitions/tapi.eth.OamJobAugmentation2" - - $ref: "#/definitions/tapi.eth.OamJobAugmentation3" - - $ref: "#/definitions/tapi.eth.OamJobAugmentation4" - - $ref: "#/definitions/tapi.eth.OamJobAugmentation5" - - $ref: "#/definitions/tapi.eth.OamJobAugmentation6" - - $ref: "#/definitions/tapi.eth.OamJobAugmentation7" - - type: "object" - properties: - schedule: - description: "none" - $ref: "#/definitions/tapi.common.TimeRange" - oam-profile: - description: "none" - $ref: "#/definitions/tapi.oam.OamProfileRef" - pm-current-data: - type: "array" - description: "Granularity period of the CurrentData identifies the specific\ - \ CurrentData instance in the scope of this OamJob.\r\n \ - \ For example, typically at least\r\n one 15min\ - \ and\r\n one 24hr;\r\n optionally\ - \ one additional configurable (< 15min)" - items: - $ref: "#/definitions/tapi.oam.oamjob.PmCurrentData" - creation-time: - type: "string" - description: "none" - oam-service-end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" - oam-job-type: - type: "string" - description: "none" - description: "none" - tapi.oam.oamcontext.OamProfile: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - pm-threshold-data: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.oamprofile.PmThresholdData" - pm-bin-data: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.PmBinData" - description: "none" - tapi.oam.oamjob.PmCurrentData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - $ref: "#/definitions/tapi.eth.PmCurrentDataAugmentation1" - - $ref: "#/definitions/tapi.eth.PmCurrentDataAugmentation10" - - $ref: "#/definitions/tapi.eth.PmCurrentDataAugmentation11" - - $ref: "#/definitions/tapi.eth.PmCurrentDataAugmentation2" - - $ref: "#/definitions/tapi.eth.PmCurrentDataAugmentation3" - - $ref: "#/definitions/tapi.eth.PmCurrentDataAugmentation4" - - $ref: "#/definitions/tapi.eth.PmCurrentDataAugmentation5" - - $ref: "#/definitions/tapi.eth.PmCurrentDataAugmentation6" - - $ref: "#/definitions/tapi.eth.PmCurrentDataAugmentation7" - - $ref: "#/definitions/tapi.eth.PmCurrentDataAugmentation8" - - $ref: "#/definitions/tapi.eth.PmCurrentDataAugmentation9" - - type: "object" - properties: - elapsed-time: - description: "none" - $ref: "#/definitions/tapi.common.TimeInterval" - pm-history-data: - type: "array" - description: "in case of 24hr Current Data, at least 1 History Data.\r\n\ - \ In case of 15min Current Data, at least 16 History\ - \ Data.\r\n In case of <15min, the number of History\ - \ Data shall be able to cover a span of 4 hours." - items: - $ref: "#/definitions/tapi.oam.pmcurrentdata.PmHistoryData" - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - suspect-interval-flag: - type: "boolean" - description: "This attribute is used to indicate that the performance data\ - \ for the current period may not be reliable. Some reasons for this to\ - \ occur are:\r\n – Suspect data were detected by the\ - \ actual resource doing data collection.\r\n – Transition\ - \ of the administrativeState attribute to/from the 'lock' state.\r\n \ - \ – Transition of the operationalState to/from the 'disabled'\ - \ state.\r\n – Scheduler setting that inhibits the\ - \ collection function.\r\n – The performance counters\ - \ were reset during the interval.\r\n – The currentData\ - \ (or subclass) object instance was created during the monitoring period." - default: false - timestamp: - type: "string" - description: "This attribute indicates the start of the current monitoring\ - \ interval.\r\n The value is bound to the quarter of\ - \ an hour in case of a 15 minute interval and bound to the hour in case\ - \ of a 24 hour interval." - description: "Granularity period of the CurrentData identifies the specific\ - \ CurrentData instance in the scope of this OamJob.\r\n \ - \ For example, typically at least\r\n one 15min and\r\n\ - \ one 24hr;\r\n optionally one additional\ - \ configurable (< 15min)" - tapi.oam.oamprofile.PmThresholdData: - allOf: - - $ref: "#/definitions/tapi.eth.PmThresholdDataAugmentation1" - - $ref: "#/definitions/tapi.eth.PmThresholdDataAugmentation2" - - $ref: "#/definitions/tapi.eth.PmThresholdDataAugmentation3" - - $ref: "#/definitions/tapi.eth.PmThresholdDataAugmentation4" - - $ref: "#/definitions/tapi.oam.PmThresholdData" - tapi.oam.pmcurrentdata.PmHistoryData: - allOf: - - $ref: "#/definitions/tapi.eth.PmHistoryDataAugmentation1" - - $ref: "#/definitions/tapi.eth.PmHistoryDataAugmentation2" - - $ref: "#/definitions/tapi.eth.PmHistoryDataAugmentation3" - - $ref: "#/definitions/tapi.eth.PmHistoryDataAugmentation4" - - $ref: "#/definitions/tapi.eth.PmHistoryDataAugmentation5" - - $ref: "#/definitions/tapi.eth.PmHistoryDataAugmentation6" - - $ref: "#/definitions/tapi.eth.PmHistoryDataAugmentation7" - - $ref: "#/definitions/tapi.eth.PmHistoryDataAugmentation8" - - $ref: "#/definitions/tapi.oam.PmHistoryData" - tapi.oam.updateoamjob.Input: - type: "object" - properties: - job-id: - type: "string" - description: "none" - schedule: - type: "string" - description: "none" - oam-profile: - description: "none" - $ref: "#/definitions/tapi.oam.OamProfile" - state: - type: "string" - description: "none" - tapi.oam.updateoamjob.Output: - type: "object" - properties: - oam-job: - description: "none" - $ref: "#/definitions/tapi.oam.OamJob" - tapi.oam.updateoamservice.Input: - type: "object" - properties: - oam-constraint: - description: "none" - $ref: "#/definitions/tapi.oam.OamConstraint" - service-id: - type: "string" - description: "none" - state: - type: "string" - description: "none" - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.oam.updateoamservice.Output: - type: "object" - properties: - service: - description: "none" - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.updateoamserviceendpoint.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - o-sep-id: - type: "string" - description: "none" - state: - type: "string" - description: "none" - tapi.oam.updateoamserviceendpoint.Output: - type: "object" - properties: - end-point: - description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.path.computation.ComputeP2PPath: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.path.computation.computep2ppath.Output" - tapi.path.computation.ContextAugmentation3: - 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.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.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.PathOptimizationConstraint: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - traffic-interruption: - description: "none" - $ref: "#/definitions/tapi.common.DirectiveValue" - description: "none" - 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.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.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 - 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" - 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.TopologyConstraint: - type: "object" - properties: - include-node: - type: "array" - description: "This is a loose constraint - that is it is unordered and could\ - \ be a partial list" - items: - $ref: "#/definitions/tapi.topology.NodeRef" - exclude-link: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.LinkRef" - avoid-topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - exclude-path: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.path.computation.PathRef" - include-link: - type: "array" - description: "This is a loose constraint - that is it is unordered and could\ - \ be a partial list " - items: - $ref: "#/definitions/tapi.topology.LinkRef" - preferred-transport-layer: - type: "array" - description: "soft constraint requested by client to indicate the layer(s)\ - \ of transport connection that it prefers to carry the service. This could\ - \ be same as the service layer or one of the supported server layers" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - exclude-node: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRef" - include-topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - include-path: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.path.computation.PathRef" - 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.ContextAugmentation5: - type: "object" - properties: - topology-context: - description: "Augments the base TAPI Context with TopologyService information" - $ref: "#/definitions/tapi.topology.TopologyContext" - x-augmentation: - prefix: "tapi-topology" - namespace: "urn:onf:otcc:yang:tapi-topology" - tapi.topology.CostCharacteristic: - type: "object" - properties: - cost-value: - type: "string" - description: "The specific cost." - cost-algorithm: - type: "string" - description: "The cost may vary based upon some properties of the TopologicalEntity.\ - \ The rules for the variation are conveyed by the costAlgorithm." - cost-name: - type: "string" - description: "The cost characteristic will related to some aspect of the TopologicalEntity\ - \ (e.g. $ cost, routing weight). This aspect will be conveyed by the costName." - tapi.topology.ForwardingRule: - type: "string" - enum: - - "MAY_FORWARD_ACROSS_GROUP" - - "MUST_FORWARD_ACROSS_GROUP" - - "CANNOT_FORWARD_ACROSS_GROUP" - - "NO_STATEMENT_ON_FORWARDING" - tapi.topology.GetLinkDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.getlinkdetails.Output" - tapi.topology.GetNodeDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.getnodedetails.Output" - tapi.topology.GetNodeEdgePointDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Output" - tapi.topology.GetTopologyDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.gettopologydetails.Output" - tapi.topology.GetTopologyList: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.gettopologylist.Output" - tapi.topology.InterRuleGroup: - allOf: - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.RiskParameterPac" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - type: "object" - properties: - associated-node-rule-group: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - rule: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Rule" - description: "none" - tapi.topology.LatencyCharacteristic: - type: "object" - properties: - traffic-property-name: - type: "string" - description: "The identifier of the specific traffic property to which the\ - \ queuing latency applies." - jitter-characteristic: - type: "string" - description: "High frequency deviation from true periodicity of a signal and\ - \ therefore a small high rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." - fixed-latency-characteristic: - type: "string" - description: "A TopologicalEntity suffers delay caused by the realization\ - \ of the servers (e.g. distance related; FEC encoding etc.) along with some\ - \ client specific processing. This is the total average latency effect of\ - \ the TopologicalEntity" - wander-characteristic: - type: "string" - description: "Low frequency deviation from true periodicity of a signal and\ - \ therefore a small low rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." - queing-latency-characteristic: - type: "string" - description: "The specific queuing latency for the traffic property." - tapi.topology.LayerProtocolTransitionPac: - type: "object" - properties: - transitioned-layer-protocol-name: - type: "array" - description: "Provides the ordered structure of layer protocol transitions\ - \ encapsulated in the TopologicalEntity. The ordering relates to the LinkPort\ - \ role." - items: - type: "string" - tapi.topology.Link: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.LayerProtocolTransitionPac" - - $ref: "#/definitions/tapi.topology.RiskParameterPac" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - $ref: "#/definitions/tapi.topology.ValidationPac" - - type: "object" - properties: - layer-protocol-name: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - 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.NetworkTopologyService: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - description: "none" - tapi.topology.Node: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - type: "object" - properties: - layer-protocol-name: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - encap-topology: - description: "none" - $ref: "#/definitions/tapi.topology.TopologyRef" - 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.NodeRef: - allOf: - - $ref: "#/definitions/tapi.topology.TopologyRef" - - type: "object" - properties: - node-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:uuid" - description: "none" - tapi.topology.NodeRuleGroup: - allOf: - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.RiskParameterPac" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - type: "object" - properties: - inter-rule-group: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.InterRuleGroup" - rule: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Rule" - composed-rule-group: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - node-edge-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - description: "none" - tapi.topology.NodeRuleGroupRef: - allOf: - - $ref: "#/definitions/tapi.topology.NodeRef" - - type: "object" - properties: - node-rule-group-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-rule-group/tapi-topology:uuid" - description: "none" - tapi.topology.ProtectionType: - type: "string" - enum: - - "NO_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" - 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.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.RiskParameterPac: - type: "object" - properties: - risk-characteristic: - type: "array" - description: "A list of risk characteristics for consideration in an analysis\ - \ of shared risk. Each element of the list represents a specific risk consideration." - items: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - tapi.topology.Rule: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - override-priority: - type: "integer" - format: "int32" - description: "none" - forwarding-rule: - description: "none" - $ref: "#/definitions/tapi.topology.ForwardingRule" - rule-type: - description: "none" - $ref: "#/definitions/tapi.topology.RuleType" - description: "none" - tapi.topology.RuleType: - type: "string" - enum: - - "FORWARDING" - - "CAPACITY" - - "COST" - - "TIMING" - - "RISK" - - "GROUPING" - tapi.topology.Topology: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - layer-protocol-name: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - link: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Link" - node: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Node" - description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ - \ topological component which is used to effect forwarding of transport characteristic\ - \ information and offers the potential to enable forwarding. \r\n \ - \ At the lowest level of recursion, an FD (within a network element\ - \ (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ - \ multiple switch matrices (FDs). " - tapi.topology.TopologyContext: - type: "object" - properties: - nw-topology-service: - description: "none" - $ref: "#/definitions/tapi.topology.NetworkTopologyService" - topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Topology" - tapi.topology.TopologyRef: - type: "object" - properties: - topology-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:uuid" - tapi.topology.TransferCostPac: - type: "object" - properties: - cost-characteristic: - type: "array" - description: "The list of costs where each cost relates to some aspect of\ - \ the TopologicalEntity." - items: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - tapi.topology.TransferIntegrityPac: - type: "object" - properties: - error-characteristic: - type: "string" - description: "Describes the degree to which the signal propagated can be errored.\ - \ \r\n Applies to TDM systems as the errored signal will\ - \ be propagated and not packet as errored packets will be discarded." - unavailable-time-characteristic: - type: "string" - description: "Describes the duration for which there may be no valid signal\ - \ propagated." - server-integrity-process-characteristic: - type: "string" - description: "Describes the effect of any server integrity enhancement process\ - \ on the characteristics of the TopologicalEntity." - delivery-order-characteristic: - type: "string" - description: "Describes the degree to which packets will be delivered out\ - \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ - \ maintain strict order." - repeat-delivery-characteristic: - type: "string" - description: "Primarily applies to packet systems where a packet may be delivered\ - \ more than once (in fault recovery for example). \r\n \ - \ It can also apply to TDM where several frames may be received twice\ - \ due to switching in a system with a large differential propagation delay." - loss-characteristic: - type: "string" - description: "Describes the acceptable characteristic of lost packets where\ - \ loss may result from discard due to errors or overflow.\r\n \ - \ Applies to packet systems and not TDM (as for TDM errored signals\ - \ are propagated unless grossly errored and overflow/underflow turns into\ - \ timing slips)." - tapi.topology.TransferTimingPac: - type: "object" - properties: - latency-characteristic: - type: "array" - description: "The effect on the latency of a queuing process. This only has\ - \ significant effect for packet based systems and has a complex characteristic." - items: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - tapi.topology.ValidationMechanism: - type: "object" - properties: - layer-protocol-adjacency-validated: - type: "string" - description: "State of validatiion" - validation-mechanism: - type: "string" - description: "Name of mechanism used to validate adjacency" - validation-robustness: - type: "string" - description: "Quality of validation (i.e. how likely is the stated validation\ - \ to be invalid)" - tapi.topology.ValidationPac: - type: "object" - properties: - validation-mechanism: - type: "array" - description: "Provides details of the specific validation mechanism(s) used\ - \ to confirm the presence of an intended topologicalEntity." - items: - $ref: "#/definitions/tapi.topology.ValidationMechanism" - tapi.topology.getlinkdetails.Input: - type: "object" - properties: - link-id-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.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" diff --git a/OAS/tapi-notification@2018-12-10.yaml b/OAS/tapi-notification@2018-12-10.yaml deleted file mode 100644 index 444643b3..00000000 --- a/OAS/tapi-notification@2018-12-10.yaml +++ /dev/null @@ -1,2484 +0,0 @@ ---- -swagger: "2.0" -info: - description: "tapi-notification,tapi-common API generated from yang definitions" - version: "1.0" - title: "tapi-notification,tapi-common API" -host: "localhost:1234" -consumes: -- "application/yang-data+json" -produces: -- "application/yang-data+json" -paths: - /data/context/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Context" - parameters: [] - responses: - 200: - description: "tapi.common.Context" - schema: - $ref: "#/definitions/tapi.common.Context" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.Context" - parameters: - - in: "body" - name: "tapi.common.Context.body-param" - description: "tapi.common.Context to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.Context" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.Context" - parameters: - - in: "body" - name: "tapi.common.Context.body-param" - description: "tapi.common.Context to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.Context" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.Context" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationContext" - parameters: [] - responses: - 200: - description: "tapi.notification.NotificationContext" - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationContext" - parameters: - - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationContext" - parameters: - - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription/: - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" - parameters: - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NotificationSubscriptionService" - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NotificationChannel" - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.Notification" - schema: - $ref: "#/definitions/tapi.notification.Notification" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of additional-info" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of changed-attributes" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NameAndValueChange" - schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of target-object-name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/tca-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.SubscriptionFilter" - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notification={uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.Notification" - schema: - $ref: "#/definitions/tapi.notification.Notification" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/additional-info={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of additional-info" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of changed-attributes" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NameAndValueChange" - schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of target-object-name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/tca-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" - /data/context/service-interface-point/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePoint" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/available-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/total-potential-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /operations/create-notification-subscription-service/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.CreateNotificationSubscriptionService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/delete-notification-subscription-service/: - post: - tags: - - "tapi-notification" - 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/get-notification-list/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.getnotificationlist.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.getnotificationlist.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-subscription-service-details/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-subscription-service-list/: - post: - tags: - - "tapi-notification" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-service-interface-point-details/: - post: - tags: - - "tapi-common" - parameters: - - in: "body" - name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.common.GetServiceInterfacePointDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-service-interface-point-list/: - post: - tags: - - "tapi-common" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.common.GetServiceInterfacePointList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-supported-notification-types/: - post: - tags: - - "tapi-notification" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetSupportedNotificationTypes" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-notification-subscription-service/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.UpdateNotificationSubscriptionService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-service-interface-point/: - post: - tags: - - "tapi-common" - parameters: - - in: "body" - name: "tapi.common.updateserviceinterfacepoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.common.updateserviceinterfacepoint.Input" - responses: - 201: - description: "No response" - 400: - description: "Internal error" -definitions: - tapi.common.AdminStatePac: - type: "object" - properties: - operational-state: - description: "none" - $ref: "#/definitions/tapi.common.OperationalState" - lifecycle-state: - description: "none" - $ref: "#/definitions/tapi.common.LifecycleState" - administrative-state: - description: "none" - $ref: "#/definitions/tapi.common.AdministrativeState" - tapi.common.AdministrativeState: - type: "string" - enum: - - "LOCKED" - - "UNLOCKED" - tapi.common.BandwidthProfile: - type: "object" - properties: - committed-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - coupling-flag: - type: "boolean" - description: "none" - default: false - bw-profile-type: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfileType" - peak-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - committed-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - peak-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - color-aware: - type: "boolean" - description: "none" - default: false - tapi.common.BandwidthProfileType: - type: "string" - enum: - - "MEF_10.x" - - "RFC_2697" - - "RFC_2698" - - "RFC_4115" - tapi.common.Capacity: - type: "object" - properties: - bandwidth-profile: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfile" - total-size: - description: "Total capacity of the TopologicalEntity in MB/s. In case of\ - \ bandwidthProfile, this is expected to same as the committedInformationRate." - $ref: "#/definitions/tapi.common.CapacityValue" - tapi.common.CapacityPac: - type: "object" - properties: - available-capacity: - description: "Capacity available to be assigned." - $ref: "#/definitions/tapi.common.Capacity" - total-potential-capacity: - description: "An optimistic view of the capacity of the TopologicalEntity\ - \ assuming that any shared capacity is available to be taken." - $ref: "#/definitions/tapi.common.Capacity" - tapi.common.CapacityUnit: - type: "string" - enum: - - "TB" - - "TBPS" - - "GB" - - "GBPS" - - "MB" - - "MBPS" - - "KB" - - "KBPS" - - "GHz" - - "MHz" - tapi.common.CapacityValue: - type: "object" - properties: - value: - type: "integer" - format: "int32" - description: "none" - unit: - description: "none" - $ref: "#/definitions/tapi.common.CapacityUnit" - tapi.common.Context: - allOf: - - $ref: "#/definitions/tapi.common.TapiContext" - - $ref: "#/definitions/tapi.notification.ContextAugmentation1" - 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.OperationalState: - type: "string" - enum: - - "DISABLED" - - "ENABLED" - tapi.common.ServiceInterfacePoint: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - supported-layer-protocol-qualifier: - type: "array" - description: "none" - items: - type: "string" - layer-protocol-name: - description: "Usage of layerProtocolName [>1] in the ServiceInterfacePoint\ - \ should be considered experimental" - $ref: "#/definitions/tapi.common.LayerProtocolName" - description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ - \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ - \ circuit and packet forms." - tapi.common.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.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.notification.AlarmInfo: - type: "object" - properties: - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedSeverityType" - probable-cause: - type: "string" - description: "none" - service-affecting: - description: "none" - $ref: "#/definitions/tapi.notification.ServiceAffecting" - is-transient: - type: "boolean" - description: "none" - default: false - tapi.notification.ContextAugmentation1: - type: "object" - properties: - notification-context: - description: "Augments the base TAPI Context with NotificationService information" - $ref: "#/definitions/tapi.notification.NotificationContext" - 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.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.NotificationContext: - type: "object" - properties: - notif-subscription: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - notification: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.Notification" - tapi.notification.NotificationSubscriptionService: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - notification: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.Notification" - notification-channel: - description: "none" - $ref: "#/definitions/tapi.notification.NotificationChannel" - subscription-state: - description: "none" - $ref: "#/definitions/tapi.notification.SubscriptionState" - supported-object-types: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.ObjectType" - supported-notification-types: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.NotificationType" - subscription-filter: - description: "none" - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - description: "none" - tapi.notification.NotificationType: - type: "string" - enum: - - "OBJECT_CREATION" - - "OBJECT_DELETION" - - "ATTRIBUTE_VALUE_CHANGE" - - "ALARM_EVENT" - - "THRESHOLD_CROSSING_ALERT" - tapi.notification.ObjectType: - type: "string" - enum: - - "TOPOLOGY" - - "NODE" - - "LINK" - - "CONNECTION" - - "PATH" - - "CONNECTIVITY_SERVICE" - - "VIRTUAL_NETWORK_SERVICE" - - "PATH_COMPUTATION_SERVICE" - - "NODE_EDGE_POINT" - - "SERVICE_INTERFACE_POINT" - - "CONNECTION_END_POINT" - - "MAINTENANCE_ENTITY_GROUP" - - "MAINTENANCE_ENTITY" - - "MEG_END_POINT" - - "MEG_INTERMEDIATE_POINT" - - "SWITCH_CONTROL" - - "SWITCH" - - "ROUTE" - - "NODE_RULE_GROUP" - - "INTER_RULE_GROUP" - - "RULE" - - "OAM_JOB" - tapi.notification.PerceivedSeverityType: - type: "string" - enum: - - "CRITICAL" - - "MAJOR" - - "MINOR" - - "WARNING" - - "CLEARED" - tapi.notification.PerceivedTcaSeverity: - type: "string" - enum: - - "WARNING" - - "CLEAR" - tapi.notification.ServiceAffecting: - type: "string" - enum: - - "SERVICE_AFFECTING" - - "NOT_SERVICE_AFFECTING" - - "UNKNOWN" - 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.SubscriptionState: - type: "string" - enum: - - "SUSPENDED" - - "ACTIVE" - tapi.notification.TcaInfo: - type: "object" - properties: - threshold-crossing: - description: "none" - $ref: "#/definitions/tapi.notification.ThresholdCrossingType" - threshold-parameter: - type: "string" - description: "none" - is-transient: - type: "boolean" - description: "none" - default: false - threshold-value: - type: "integer" - format: "int32" - description: "none" - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedTcaSeverity" - suspect-interval-flag: - type: "boolean" - description: "none" - default: false - measurement-interval: - type: "string" - description: "none" - tapi.notification.ThresholdCrossingType: - type: "string" - enum: - - "THRESHOLD_ABOVE" - - "THRESHOLD_BELOW" - - "CLEARED" - tapi.notification.UpdateNotificationSubscriptionService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Output" - tapi.notification.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" diff --git a/OAS/tapi-oam@2018-12-10.yaml b/OAS/tapi-oam@2018-12-10.yaml deleted file mode 100644 index b621980b..00000000 --- a/OAS/tapi-oam@2018-12-10.yaml +++ /dev/null @@ -1,17630 +0,0 @@ ---- -swagger: "2.0" -info: - description: "tapi-oam,tapi-path-computation,tapi-connectivity,tapi-notification,tapi-topology,tapi-common\ - \ API generated from yang definitions" - version: "1.0" - title: "tapi-oam,tapi-path-computation,tapi-connectivity,tapi-notification,tapi-topology,tapi-common\ - \ API" -host: "localhost:1234" -consumes: -- "application/yang-data+json" -produces: -- "application/yang-data+json" -paths: - /data/context/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Context" - parameters: [] - responses: - 200: - description: "tapi.common.Context" - schema: - $ref: "#/definitions/tapi.common.Context" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.Context" - parameters: - - in: "body" - name: "tapi.common.Context.body-param" - description: "tapi.common.Context to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.Context" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.Context" - parameters: - - in: "body" - name: "tapi.common.Context.body-param" - description: "tapi.common.Context to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.Context" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.Context" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityContext" - parameters: [] - responses: - 200: - description: "tapi.connectivity.ConnectivityContext" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityContext" - 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.ConnectivityContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityContext" - 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.ConnectivityContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connection={uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.Connection" - parameters: - - name: "uuid" - in: "path" - description: "Id of connection" - required: true - type: "string" - responses: - 200: - description: "tapi.connectivity.Connection" - schema: - $ref: "#/definitions/tapi.connectivity.Connection" - 400: - description: "Internal error" - ? /data/context/connectivity-context/connection={uuid}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" - 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.ConnectionEndPointRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/lower-connection={connection-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionRef" - 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.ConnectionRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - 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.NameAndValue" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/route={local-id}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.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.Route" - schema: - $ref: "#/definitions/tapi.connectivity.Route" - 400: - description: "Internal error" - ? /data/context/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" - description: "returns tapi.connectivity.ConnectionEndPointRef" - 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.ConnectionEndPointRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/route={local-id}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - 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.NameAndValue" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/supported-client-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" - 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.LinkRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.SwitchControl" - 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.SwitchControl" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - 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.NameAndValue" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/resilience-type/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of connection" - required: true - type: "string" - - name: "switch-control-uuid" - in: "path" - description: "Id of switch-control" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" - ? /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/sub-switch-control={connection-uuid},{sub-switch-control-switch-control-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.SwitchControlRef" - 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.SwitchControlRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/switch={local-id}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.Switch" - 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.Switch" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/switch={local-id}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - 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.NameAndValue" - 400: - description: "Internal error" - ? /data/context/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" - description: "returns tapi.connectivity.ConnectionEndPointRef" - 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.ConnectionEndPointRef" - 400: - description: "Internal error" - ? /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/switch={local-id}/selected-route={connection-uuid},{route-local-id}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.RouteRef" - 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.RouteRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityService" - 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.ConnectivityService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityService" - 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.ConnectivityService" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityService" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityService.body-param" - description: "tapi.connectivity.ConnectivityService to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityService" - 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.ConnectivityService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityService" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/avoid-topology={topology-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of avoid-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/connection={connection-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionRef" - 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.ConnectionRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/coroute-inclusion/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceRef" - 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.ConnectivityServiceRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceRef" - 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.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/cost-characteristic/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.CostCharacteristic" - 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.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/diversity-exclusion/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" - 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.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/diversity-exclusion={connectivity-service-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "connectivity-service-uuid" - in: "path" - description: "Id of diversity-exclusion" - required: true - type: "string" - responses: - 200: - description: "tapi.connectivity.ConnectivityServiceRef" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "connectivity-service-uuid" - in: "path" - description: "Id of diversity-exclusion" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceRef" - 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.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "connectivity-service-uuid" - in: "path" - description: "Id of diversity-exclusion" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPoint to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceEndPoint" - 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.ConnectivityServiceEndPoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPoint to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceEndPoint" - 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.ConnectivityServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.Capacity" - 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.Capacity" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.Capacity" - 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.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.BandwidthProfile" - 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.BandwidthProfile" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/total-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.connectivity.ConnectionEndPointRef" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - 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.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/service-interface-point/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.ServiceInterfacePointRef" - 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.ServiceInterfacePointRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.ServiceInterfacePointRef" - 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.ServiceInterfacePointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.ServiceInterfacePointRef" - 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.ServiceInterfacePointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-path={path-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of exclude-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-path={path-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of include-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-topology={topology-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/latency-characteristic/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.LatencyCharacteristic" - 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.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/name/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.Capacity" - 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.Capacity" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.Capacity" - 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.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.BandwidthProfile" - 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.BandwidthProfile" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/total-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/resilience-type/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.ResilienceType" - 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.ResilienceType" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.ResilienceType" - parameters: - - name: "uuid" - 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.ResilienceType" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/risk-diversity-characteristic/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/risk-diversity-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/schedule/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.TimeRange" - 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.TimeRange" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.TimeRange" - 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.TimeRange" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.TimeRange" - parameters: - - name: "uuid" - 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.TimeRange" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.TimeRange" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationContext" - parameters: [] - responses: - 200: - description: "tapi.notification.NotificationContext" - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationContext" - parameters: - - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationContext" - parameters: - - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription/: - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" - parameters: - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NotificationSubscriptionService" - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NotificationChannel" - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.Notification" - schema: - $ref: "#/definitions/tapi.notification.Notification" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of additional-info" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of changed-attributes" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NameAndValueChange" - schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of target-object-name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/tca-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.SubscriptionFilter" - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notification={uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.Notification" - schema: - $ref: "#/definitions/tapi.notification.Notification" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/additional-info={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of additional-info" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of changed-attributes" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NameAndValueChange" - schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of target-object-name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/tca-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" - /data/context/oam-context/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamContext" - parameters: [] - responses: - 200: - description: "tapi.oam.OamContext" - schema: - $ref: "#/definitions/tapi.oam.OamContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamContext" - parameters: - - in: "body" - name: "tapi.oam.OamContext.body-param" - description: "tapi.oam.OamContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamContext" - parameters: - - in: "body" - name: "tapi.oam.OamContext.body-param" - description: "tapi.oam.OamContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/meg={uuid}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.Meg" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.Meg" - schema: - $ref: "#/definitions/tapi.oam.Meg" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.Mep" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.Mep" - schema: - $ref: "#/definitions/tapi.oam.Mep" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.Mip" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.Mip" - schema: - $ref: "#/definitions/tapi.oam.Mip" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/oam-context/oam-job/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamJob" - parameters: - - in: "body" - name: "tapi.oam.OamJob.body-param" - description: "tapi.oam.OamJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamJob" - schema: - $ref: "#/definitions/tapi.oam.OamJob" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamJob.body-param" - description: "tapi.oam.OamJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamJob.body-param" - description: "tapi.oam.OamJob to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/oam-profile/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamProfileRef" - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/oam-service-end-point/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/oam-service-end-point={oam-service-uuid},{oam-service-end-point-local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - name: "oam-service-end-point-local-id" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamServiceEndPointRef" - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - name: "oam-service-end-point-local-id" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - name: "oam-service-end-point-local-id" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - name: "oam-service-end-point-local-id" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.PmCurrentData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.PmCurrentData" - schema: - $ref: "#/definitions/tapi.oam.PmCurrentData" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/elapsed-time/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimeInterval" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimeInterval" - schema: - $ref: "#/definitions/tapi.common.TimeInterval" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/elapsed-time/period={unit}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "unit" - in: "path" - description: "Id of period" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/granularity-period/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.PmHistoryData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.PmHistoryData" - schema: - $ref: "#/definitions/tapi.oam.PmHistoryData" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/granularity-period/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/name={value-name}/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/schedule/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimeRange" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimeRange" - schema: - $ref: "#/definitions/tapi.common.TimeRange" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.TimeRange" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.TimeRange" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.TimeRange" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.TimeRange" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.TimeRange" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamProfile" - parameters: - - in: "body" - name: "tapi.oam.OamProfile.body-param" - description: "tapi.oam.OamProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamProfile" - schema: - $ref: "#/definitions/tapi.oam.OamProfile" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfile.body-param" - description: "tapi.oam.OamProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfile.body-param" - description: "tapi.oam.OamProfile to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.PmBinData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmBinData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.PmBinData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.PmBinData" - schema: - $ref: "#/definitions/tapi.oam.PmBinData" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.PmBinData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmBinData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.PmBinData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmBinData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.PmBinData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/granularity-period/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmThresholdData.body-param" - description: "tapi.oam.PmThresholdData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.PmThresholdData" - schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmThresholdData.body-param" - description: "tapi.oam.PmThresholdData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmThresholdData.body-param" - description: "tapi.oam.PmThresholdData to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/granularity-period/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamService" - parameters: - - in: "body" - name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamService" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamService" - schema: - $ref: "#/definitions/tapi.oam.OamService" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamService" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamService" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamService" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamServiceEndPoint" - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/connectivity-service-end-point/: - get: - tags: - - "tapi-oam" - description: "returns tapi.connectivity.ConnectivityServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.connectivity.ConnectivityServiceEndPointRef" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.connectivity.ConnectivityServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.connectivity.ConnectivityServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/mep/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MepRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MepRef" - schema: - $ref: "#/definitions/tapi.oam.MepRef" - 400: - description: "Internal error" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/mip/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MipRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MipRef" - schema: - $ref: "#/definitions/tapi.oam.MipRef" - 400: - description: "Internal error" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/service-interface-point/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePointRef.body-param" - description: "tapi.common.ServiceInterfacePointRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePointRef.body-param" - description: "tapi.common.ServiceInterfacePointRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/meg/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MegRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MegRef" - schema: - $ref: "#/definitions/tapi.oam.MegRef" - 400: - description: "Internal error" - /data/context/oam-context/oam-service={uuid}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/oam-profile/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamProfileRef" - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathComputationContext" - parameters: [] - responses: - 200: - description: "tapi.path.computation.PathComputationContext" - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationContext" - parameters: - - in: "body" - name: "tapi.path.computation.PathComputationContext.body-param" - description: "tapi.path.computation.PathComputationContext to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathComputationContext" - parameters: - - in: "body" - name: "tapi.path.computation.PathComputationContext.body-param" - description: "tapi.path.computation.PathComputationContext to be added or\ - \ updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathComputationContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationService" - parameters: - - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathComputationService" - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - 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.PathComputationService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - 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.PathServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathServiceEndPoint" - schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.Capacity" - 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.Capacity" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.Capacity" - 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.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.Capacity" - 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.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.BandwidthProfile" - 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.BandwidthProfile" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/total-size/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/service-interface-point/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathObjectiveFunction" - schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathObjectiveFunction.body-param" - description: "tapi.path.computation.PathObjectiveFunction to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathObjectiveFunction.body-param" - description: "tapi.path.computation.PathObjectiveFunction to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathOptimizationConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathOptimizationConstraint.body-param" - description: "tapi.path.computation.PathOptimizationConstraint to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathOptimizationConstraint.body-param" - description: "tapi.path.computation.PathOptimizationConstraint to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.RoutingConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.RoutingConstraint.body-param" - description: "tapi.path.computation.RoutingConstraint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.RoutingConstraint.body-param" - description: "tapi.path.computation.RoutingConstraint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.TopologyConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.TopologyConstraint.body-param" - description: "tapi.path.computation.TopologyConstraint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.TopologyConstraint.body-param" - description: "tapi.path.computation.TopologyConstraint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/avoid-topology={topology-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of avoid-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of exclude-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of include-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-topology={topology-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.Path" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.Path" - schema: - $ref: "#/definitions/tapi.path.computation.Path" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.RoutingConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/service-interface-point/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePoint" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/available-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/total-potential-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyContext" - parameters: [] - responses: - 200: - description: "tapi.topology.TopologyContext" - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-topology" - description: "creates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.context.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-topology" - description: "creates or updates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.context.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-topology" - description: "removes tapi.topology.TopologyContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/topology-context/nw-topology-service/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NetworkTopologyService" - parameters: [] - responses: - 200: - description: "tapi.topology.NetworkTopologyService" - schema: - $ref: "#/definitions/tapi.topology.NetworkTopologyService" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "topology-uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Topology" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Topology" - schema: - $ref: "#/definitions/tapi.topology.Topology" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Link" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Link" - schema: - $ref: "#/definitions/tapi.topology.Link" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/resilience-type/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ValidationMechanism" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "validation-mechanism" - in: "path" - description: "Id of validation-mechanism" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ValidationMechanism" - schema: - $ref: "#/definitions/tapi.topology.ValidationMechanism" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.topology.Node" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.topology.Node" - schema: - $ref: "#/definitions/tapi.topology.topology.Node" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroup" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroup" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-rule-group-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroupRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.InterRuleGroup" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.InterRuleGroup" - schema: - $ref: "#/definitions/tapi.topology.InterRuleGroup" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-rule-group-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroupRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Rule" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Rule" - schema: - $ref: "#/definitions/tapi.topology.Rule" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Rule" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Rule" - schema: - $ref: "#/definitions/tapi.topology.Rule" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.node.OwnedNodeEdgePoint" - parameters: - - name: "uuid" - 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.OwnedNodeEdgePoint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - 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.context.topologycontext.topology.node.ownednodeedgepoint.CepList" - schema: - $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ceplist.ConnectionEndPoint" - parameters: - - name: "uuid" - 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.ceplist.ConnectionEndPoint" - schema: - $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/aggregated-connection-end-point={topology-uuid},{aggregated-connection-end-point-node-uuid},{node-edge-point-uuid},{aggregated-connection-end-point-connection-end-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" - parameters: - - name: "uuid" - 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.ConnectionEndPointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/client-node-edge-point={topology-uuid},{client-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - 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.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MepMipList" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MepMipList" - schema: - $ref: "#/definitions/tapi.oam.MepMipList" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mep={meg-uuid},{mep-local-id}/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MepRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "meg-uuid" - in: "path" - description: "Id of mep" - required: true - type: "string" - - name: "mep-local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MepRef" - schema: - $ref: "#/definitions/tapi.oam.MepRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mip={meg-uuid},{mip-local-id}/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MipRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "meg-uuid" - in: "path" - description: "Id of mip" - required: true - type: "string" - - name: "mip-local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MipRef" - schema: - $ref: "#/definitions/tapi.oam.MipRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/name={value-name}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/parent-node-edge-point/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "service-interface-point-uuid" - in: "path" - description: "Id of mapped-service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /operations/compute-p-2-p-path/: - post: - tags: - - "tapi-path-computation" - parameters: - - in: "body" - name: "tapi.path.computation.computep2ppath.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.path.computation.computep2ppath.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.path.computation.ComputeP2PPath" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-connectivity-service/: - post: - tags: - - "tapi-connectivity" - parameters: - - in: "body" - name: "tapi.connectivity.createconnectivityservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.connectivity.createconnectivityservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.connectivity.CreateConnectivityService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-notification-subscription-service/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.CreateNotificationSubscriptionService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-oam-job/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.createoamjob.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.createoamjob.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.CreateOamJob" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-oam-service-end-point/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.createoamserviceendpoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.createoamserviceendpoint.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.CreateOamServiceEndPoint" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-oam-service/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.createoamservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.createoamservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.CreateOamService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/delete-connectivity-service/: - post: - tags: - - "tapi-connectivity" - 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/delete-notification-subscription-service/: - post: - tags: - - "tapi-notification" - 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/delete-oam-job/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.deleteoamjob.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.deleteoamjob.Input" - responses: - 201: - description: "No response" - 400: - description: "Internal error" - /operations/delete-oam-service-end-point/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.deleteoamserviceendpoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.deleteoamserviceendpoint.Input" - responses: - 201: - description: "No response" - 400: - description: "Internal error" - /operations/delete-oam-service/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.deleteoamservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.deleteoamservice.Input" - responses: - 201: - description: "No response" - 400: - description: "Internal error" - /operations/delete-p-2-p-path/: - post: - tags: - - "tapi-path-computation" - 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/get-connection-details/: - post: - tags: - - "tapi-connectivity" - 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/get-connection-end-point-details/: - post: - tags: - - "tapi-connectivity" - 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/get-connectivity-service-details/: - post: - tags: - - "tapi-connectivity" - 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/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/get-link-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.getlinkdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.getlinkdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetLinkDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-meg/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.getmeg.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.getmeg.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.GetMeg" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-node-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.getnodedetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.getnodedetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetNodeDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-node-edge-point-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.getnodeedgepointdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetNodeEdgePointDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-list/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.getnotificationlist.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.getnotificationlist.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-subscription-service-details/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-subscription-service-list/: - post: - tags: - - "tapi-notification" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-oam-job/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.getoamjob.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.getoamjob.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.GetOamJob" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-oam-service-end-point/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.getoamserviceendpoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.getoamserviceendpoint.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.GetOamServiceEndPoint" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-oam-service-list/: - post: - tags: - - "tapi-oam" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.GetOamServiceList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-oam-service/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.getoamservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.getoamservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.GetOamService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-service-interface-point-details/: - post: - tags: - - "tapi-common" - parameters: - - in: "body" - name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.common.GetServiceInterfacePointDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-service-interface-point-list/: - post: - tags: - - "tapi-common" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.common.GetServiceInterfacePointList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-supported-notification-types/: - post: - tags: - - "tapi-notification" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetSupportedNotificationTypes" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-topology-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.gettopologydetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.gettopologydetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetTopologyDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-topology-list/: - post: - tags: - - "tapi-topology" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetTopologyList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/optimize-p-2-p-path/: - post: - tags: - - "tapi-path-computation" - 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/update-connectivity-service/: - post: - tags: - - "tapi-connectivity" - 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/update-notification-subscription-service/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.UpdateNotificationSubscriptionService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-oam-job/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.updateoamjob.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.updateoamjob.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.UpdateOamJob" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-oam-service-end-point/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.updateoamserviceendpoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.updateoamserviceendpoint.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.UpdateOamServiceEndPoint" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-oam-service/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.updateoamservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.updateoamservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.UpdateOamService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-service-interface-point/: - post: - tags: - - "tapi-common" - parameters: - - in: "body" - name: "tapi.common.updateserviceinterfacepoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.common.updateserviceinterfacepoint.Input" - responses: - 201: - description: "No response" - 400: - description: "Internal error" -definitions: - tapi.common.AdminStatePac: - type: "object" - properties: - operational-state: - description: "none" - $ref: "#/definitions/tapi.common.OperationalState" - lifecycle-state: - description: "none" - $ref: "#/definitions/tapi.common.LifecycleState" - administrative-state: - description: "none" - $ref: "#/definitions/tapi.common.AdministrativeState" - tapi.common.AdministrativeState: - type: "string" - enum: - - "LOCKED" - - "UNLOCKED" - tapi.common.BandwidthProfile: - type: "object" - properties: - committed-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - coupling-flag: - type: "boolean" - description: "none" - default: false - bw-profile-type: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfileType" - peak-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - committed-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - peak-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - color-aware: - type: "boolean" - description: "none" - default: false - tapi.common.BandwidthProfileType: - type: "string" - enum: - - "MEF_10.x" - - "RFC_2697" - - "RFC_2698" - - "RFC_4115" - tapi.common.Capacity: - type: "object" - properties: - bandwidth-profile: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfile" - total-size: - description: "Total capacity of the TopologicalEntity in MB/s. In case of\ - \ bandwidthProfile, this is expected to same as the committedInformationRate." - $ref: "#/definitions/tapi.common.CapacityValue" - tapi.common.CapacityPac: - type: "object" - properties: - available-capacity: - description: "Capacity available to be assigned." - $ref: "#/definitions/tapi.common.Capacity" - total-potential-capacity: - description: "An optimistic view of the capacity of the TopologicalEntity\ - \ assuming that any shared capacity is available to be taken." - $ref: "#/definitions/tapi.common.Capacity" - tapi.common.CapacityUnit: - type: "string" - enum: - - "TB" - - "TBPS" - - "GB" - - "GBPS" - - "MB" - - "MBPS" - - "KB" - - "KBPS" - - "GHz" - - "MHz" - tapi.common.CapacityValue: - type: "object" - properties: - value: - type: "integer" - format: "int32" - description: "none" - unit: - description: "none" - $ref: "#/definitions/tapi.common.CapacityUnit" - tapi.common.Context: - allOf: - - $ref: "#/definitions/tapi.common.TapiContext" - - $ref: "#/definitions/tapi.connectivity.ContextAugmentation4" - - $ref: "#/definitions/tapi.notification.ContextAugmentation2" - - $ref: "#/definitions/tapi.oam.ContextAugmentation1" - - $ref: "#/definitions/tapi.path.computation.ContextAugmentation3" - - $ref: "#/definitions/tapi.topology.ContextAugmentation5" - 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.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" - description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ - \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ - \ circuit and packet forms." - tapi.common.ServiceInterfacePointRef: - type: "object" - properties: - service-interface-point-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-common:service-interface-point/tapi-common:uuid" - tapi.common.TapiContext: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - service-interface-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - description: "The Network Control Domain (NCD) object class represents the scope\ - \ of control that a particular SDN controller has with respect to a particular\ - \ network, (i.e., encompassing a designated set of interconnected (virtual)\ - \ network elements)." - tapi.common.TerminationDirection: - type: "string" - enum: - - "BIDIRECTIONAL" - - "SINK" - - "SOURCE" - - "UNDEFINED_OR_UNKNOWN" - tapi.common.TerminationPac: - type: "object" - properties: - termination-direction: - description: "The overall directionality of the LP. \r\n \ - \ - A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ - \ - A SINK LP can only contain elements with SINK flows\ - \ or CONTRA_DIRECTION_SOURCE flows\r\n - A SOURCE LP\ - \ can only contain SOURCE flows or CONTRA_DIRECTION_SINK flows" - $ref: "#/definitions/tapi.common.TerminationDirection" - termination-state: - description: "Indicates whether the layer is terminated and if so how." - $ref: "#/definitions/tapi.common.TerminationState" - tapi.common.TerminationState: - type: "string" - enum: - - "LP_CAN_NEVER_TERMINATE" - - "LT_NOT_TERMINATED" - - "TERMINATED_SERVER_TO_CLIENT_FLOW" - - "TERMINATED_CLIENT_TO_SERVER_FLOW" - - "TERMINATED_BIDIRECTIONAL" - - "LT_PERMENANTLY_TERMINATED" - - "TERMINATION_STATE_UNKNOWN" - tapi.common.TimeInterval: - type: "object" - properties: - period: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.TimePeriod" - tapi.common.TimePeriod: - type: "object" - properties: - value: - type: "integer" - format: "int32" - description: "none" - unit: - description: "none" - $ref: "#/definitions/tapi.common.TimeUnit" - tapi.common.TimeRange: - type: "object" - properties: - end-time: - type: "string" - description: "none" - start-time: - type: "string" - description: "none" - tapi.common.TimeUnit: - type: "string" - enum: - - "YEARS" - - "MONTHS" - - "DAYS" - - "HOURS" - - "MINUTES" - - "SECONDS" - - "MILLISECONDS" - - "MICROSECONDS" - - "NANOSECONDS" - - "PICOSECONDS" - 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.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" - 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" - 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.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.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" - 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" - coroute-inclusion: - description: "none" - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" - tapi.connectivity.ConnectivityContext: - type: "object" - properties: - connectivity-service: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ConnectivityService" - connection: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.Connection" - tapi.connectivity.ConnectivityService: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" - - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - - type: "object" - properties: - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" - connection: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ConnectionRef" - description: "The ForwardingConstruct (FC) object class models enabled potential\ - \ for forwarding between two or more LTPs and like the LTP supports any transport\ - \ protocol including all circuit and packet forms.\r\n At the\ - \ lowest level of recursion, a FC represents a cross-connection within an\ - \ NE." - tapi.connectivity.ConnectivityServiceEndPoint: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $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" - 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" - 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.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.ContextAugmentation4: - 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.context.topologycontext.topology.node.ownednodeedgepoint.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.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" - description: "The FC Route (FcRoute) object class models the individual routes\ - \ of an FC. \r\n The route of an FC object is represented by\ - \ a list of FCs at a lower level. \r\n Note that depending\ - \ on the service supported by an FC, an the FC can have multiple routes." - 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.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.UpdateConnectivityService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.connectivity.updateconnectivityservice.Output" - tapi.connectivity.ceplist.ConnectionEndPoint: - allOf: - - $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" - - $ref: "#/definitions/tapi.oam.ConnectionEndPointAugmentation1" - tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList: - allOf: - - type: "object" - properties: - connection-end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" - description: "none" - 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.ContextAugmentation2: - 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.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.NotificationContext: - type: "object" - properties: - notif-subscription: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - notification: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.Notification" - tapi.notification.NotificationSubscriptionService: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - notification: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.Notification" - notification-channel: - description: "none" - $ref: "#/definitions/tapi.notification.NotificationChannel" - subscription-state: - description: "none" - $ref: "#/definitions/tapi.notification.SubscriptionState" - supported-object-types: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.ObjectType" - supported-notification-types: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.NotificationType" - subscription-filter: - description: "none" - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - description: "none" - tapi.notification.NotificationType: - type: "string" - enum: - - "OBJECT_CREATION" - - "OBJECT_DELETION" - - "ATTRIBUTE_VALUE_CHANGE" - - "ALARM_EVENT" - - "THRESHOLD_CROSSING_ALERT" - tapi.notification.ObjectType: - type: "string" - enum: - - "TOPOLOGY" - - "NODE" - - "LINK" - - "CONNECTION" - - "PATH" - - "CONNECTIVITY_SERVICE" - - "VIRTUAL_NETWORK_SERVICE" - - "PATH_COMPUTATION_SERVICE" - - "NODE_EDGE_POINT" - - "SERVICE_INTERFACE_POINT" - - "CONNECTION_END_POINT" - - "MAINTENANCE_ENTITY_GROUP" - - "MAINTENANCE_ENTITY" - - "MEG_END_POINT" - - "MEG_INTERMEDIATE_POINT" - - "SWITCH_CONTROL" - - "SWITCH" - - "ROUTE" - - "NODE_RULE_GROUP" - - "INTER_RULE_GROUP" - - "RULE" - - "OAM_JOB" - tapi.notification.PerceivedSeverityType: - type: "string" - enum: - - "CRITICAL" - - "MAJOR" - - "MINOR" - - "WARNING" - - "CLEARED" - tapi.notification.PerceivedTcaSeverity: - type: "string" - enum: - - "WARNING" - - "CLEAR" - tapi.notification.ServiceAffecting: - type: "string" - enum: - - "SERVICE_AFFECTING" - - "NOT_SERVICE_AFFECTING" - - "UNKNOWN" - 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.SubscriptionState: - type: "string" - enum: - - "SUSPENDED" - - "ACTIVE" - tapi.notification.TcaInfo: - type: "object" - properties: - threshold-crossing: - description: "none" - $ref: "#/definitions/tapi.notification.ThresholdCrossingType" - threshold-parameter: - type: "string" - description: "none" - is-transient: - type: "boolean" - description: "none" - default: false - threshold-value: - type: "integer" - format: "int32" - description: "none" - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedTcaSeverity" - suspect-interval-flag: - type: "boolean" - description: "none" - default: false - measurement-interval: - type: "string" - description: "none" - tapi.notification.ThresholdCrossingType: - type: "string" - enum: - - "THRESHOLD_ABOVE" - - "THRESHOLD_BELOW" - - "CLEARED" - tapi.notification.UpdateNotificationSubscriptionService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Output" - tapi.notification.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.oam.ConnectionEndPointAugmentation1: - type: "object" - properties: - mep-mip-list: - description: "none" - $ref: "#/definitions/tapi.oam.MepMipList" - x-augmentation: - prefix: "tapi-oam" - namespace: "urn:onf:otcc:yang:tapi-oam" - tapi.oam.ContextAugmentation1: - type: "object" - properties: - oam-context: - description: "Augments the base TAPI Context with OamService information" - $ref: "#/definitions/tapi.oam.OamContext" - x-augmentation: - prefix: "tapi-oam" - namespace: "urn:onf:otcc:yang:tapi-oam" - tapi.oam.CreateOamJob: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.createoamjob.Output" - tapi.oam.CreateOamService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.createoamservice.Output" - tapi.oam.CreateOamServiceEndPoint: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.createoamserviceendpoint.Output" - tapi.oam.GetMeg: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.getmeg.Output" - tapi.oam.GetOamJob: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.getoamjob.Output" - tapi.oam.GetOamService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.getoamservice.Output" - tapi.oam.GetOamServiceEndPoint: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.getoamserviceendpoint.Output" - tapi.oam.GetOamServiceList: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.getoamservicelist.Output" - tapi.oam.Meg: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.common.OperationalStatePac" - - type: "object" - properties: - meg-identifier: - type: "string" - description: "none" - meg-level: - type: "integer" - format: "int32" - description: "none" - mip: - type: "array" - description: "ME may 0, 1, or more MIPs" - items: - $ref: "#/definitions/tapi.oam.Mip" - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - mep: - type: "array" - description: "1. ME may have 0 MEPs (case of transit domains where at least\ - \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case\ - \ of edge domaind, where the peer MEP is ouside the managed domain)\r\n\ - \ 3. ME may have 2 MEPs" - items: - $ref: "#/definitions/tapi.oam.Mep" - direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" - description: "none" - tapi.oam.MegRef: - type: "object" - properties: - meg-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:uuid" - tapi.oam.Mep: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - $ref: "#/definitions/tapi.common.OperationalStatePac" - - type: "object" - properties: - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - peer-mep-identifier: - type: "array" - description: "none" - items: - type: "string" - mep-identifier: - type: "string" - description: "none" - direction: - description: "none" - $ref: "#/definitions/tapi.common.TerminationDirection" - description: "none" - tapi.oam.MepMipList: - type: "object" - properties: - mip: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.MipRef" - mep: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.MepRef" - tapi.oam.MepRef: - allOf: - - $ref: "#/definitions/tapi.oam.MegRef" - - type: "object" - properties: - mep-local-id: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:mep/tapi-oam:local-id" - description: "none" - tapi.oam.Mip: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - description: "none" - tapi.oam.MipRef: - allOf: - - $ref: "#/definitions/tapi.oam.MegRef" - - type: "object" - properties: - mip-local-id: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:mip/tapi-oam:local-id" - description: "none" - tapi.oam.OamConstraint: - type: "object" - properties: - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - meg-level: - type: "integer" - format: "int32" - description: "none" - direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" - tapi.oam.OamContext: - type: "object" - properties: - oam-service: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamService" - oam-profile: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamProfile" - oam-job: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamJob" - meg: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.Meg" - tapi.oam.OamJob: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - schedule: - description: "none" - $ref: "#/definitions/tapi.common.TimeRange" - oam-profile: - description: "none" - $ref: "#/definitions/tapi.oam.OamProfileRef" - pm-current-data: - type: "array" - description: "Granularity period of the CurrentData identifies the specific\ - \ CurrentData instance in the scope of this OamJob.\r\n \ - \ For example, typically at least\r\n one 15min\ - \ and\r\n one 24hr;\r\n optionally\ - \ one additional configurable (< 15min)" - items: - $ref: "#/definitions/tapi.oam.PmCurrentData" - creation-time: - type: "string" - description: "none" - oam-service-end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" - oam-job-type: - type: "string" - description: "none" - description: "none" - tapi.oam.OamProfile: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - pm-threshold-data: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.PmThresholdData" - pm-bin-data: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.PmBinData" - description: "none" - tapi.oam.OamProfileRef: - type: "object" - properties: - oam-profile-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-profile/tapi-oam:uuid" - tapi.oam.OamService: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.oam.OamConstraint" - - type: "object" - properties: - oam-profile: - description: "none" - $ref: "#/definitions/tapi.oam.OamProfileRef" - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - meg: - description: "none" - $ref: "#/definitions/tapi.oam.MegRef" - description: "none" - tapi.oam.OamServiceEndPoint: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - peer-mep-identifier: - type: "array" - description: "This attribute models the MI_PeerMEP_ID[i] defined in G.8021\ - \ and configured as specified in G.8051. It provides the identifiers of\ - \ the MEPs which are peer to the subject MEP.\r\n This\ - \ attribute is not specified in case the OSEP relates to the provisioing\ - \ of an MIP.\r\n In case of P2P, there is only one\ - \ peer" - items: - type: "string" - connectivity-service-end-point: - description: "none" - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" - mip: - description: "none" - $ref: "#/definitions/tapi.oam.MipRef" - service-interface-point: - description: "none" - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - mep: - description: "none" - $ref: "#/definitions/tapi.oam.MepRef" - mep-identifier: - type: "string" - description: "This attribute contains the identifier of the MEP.\r\n \ - \ This attribute is empty in case the OSEP relates to\ - \ the provisioing of an MIP.\r\n " - direction: - description: "none" - $ref: "#/definitions/tapi.common.PortDirection" - description: "none" - tapi.oam.OamServiceEndPointRef: - allOf: - - $ref: "#/definitions/tapi.oam.OamServiceRef" - - type: "object" - properties: - oam-service-end-point-local-id: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:end-point/tapi-oam:local-id" - description: "none" - tapi.oam.OamServiceRef: - type: "object" - properties: - oam-service-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:uuid" - tapi.oam.PmBinData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - description: "none" - tapi.oam.PmCurrentData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - elapsed-time: - description: "none" - $ref: "#/definitions/tapi.common.TimeInterval" - pm-history-data: - type: "array" - description: "in case of 24hr Current Data, at least 1 History Data.\r\n\ - \ In case of 15min Current Data, at least 16 History\ - \ Data.\r\n In case of <15min, the number of History\ - \ Data shall be able to cover a span of 4 hours." - items: - $ref: "#/definitions/tapi.oam.PmHistoryData" - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - suspect-interval-flag: - type: "boolean" - description: "This attribute is used to indicate that the performance data\ - \ for the current period may not be reliable. Some reasons for this to\ - \ occur are:\r\n – Suspect data were detected by the\ - \ actual resource doing data collection.\r\n – Transition\ - \ of the administrativeState attribute to/from the 'lock' state.\r\n \ - \ – Transition of the operationalState to/from the 'disabled'\ - \ state.\r\n – Scheduler setting that inhibits the\ - \ collection function.\r\n – The performance counters\ - \ were reset during the interval.\r\n – The currentData\ - \ (or subclass) object instance was created during the monitoring period." - default: false - timestamp: - type: "string" - description: "This attribute indicates the start of the current monitoring\ - \ interval.\r\n The value is bound to the quarter of\ - \ an hour in case of a 15 minute interval and bound to the hour in case\ - \ of a 24 hour interval." - description: "none" - tapi.oam.PmHistoryData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - period-end-time: - type: "string" - description: "none" - suspect-interval-flag: - type: "boolean" - description: "This attribute indicates that the performance data may not\ - \ be reliable." - default: false - description: "none" - tapi.oam.PmThresholdData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - is-transient: - type: "boolean" - description: "none" - default: false - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - description: "none" - tapi.oam.UpdateOamJob: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.updateoamjob.Output" - tapi.oam.UpdateOamService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.updateoamservice.Output" - tapi.oam.UpdateOamServiceEndPoint: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.updateoamserviceendpoint.Output" - tapi.oam.createoamjob.Input: - type: "object" - properties: - schedule: - type: "string" - description: "none" - oam-service-end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - oam-job-type: - type: "string" - description: "none" - oam-profile: - description: "none" - $ref: "#/definitions/tapi.oam.OamProfile" - state: - type: "string" - description: "none" - tapi.oam.createoamjob.Output: - type: "object" - properties: - oam-job: - description: "none" - $ref: "#/definitions/tapi.oam.OamJob" - tapi.oam.createoamservice.Input: - type: "object" - properties: - oam-constraint: - description: "none" - $ref: "#/definitions/tapi.oam.OamConstraint" - state: - type: "string" - description: "none" - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.oam.createoamservice.Output: - type: "object" - properties: - service: - description: "none" - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.createoamserviceendpoint.Input: - type: "object" - properties: - peer-mep-identifier: - type: "array" - description: "none" - items: - type: "string" - service-id: - type: "string" - description: "none" - sip-id: - type: "string" - description: "none" - c-sep-id: - type: "string" - description: "none" - mep-identifier: - type: "string" - description: "none" - state: - type: "string" - description: "none" - layer: - type: "string" - description: "none" - direction: - type: "string" - description: "none" - tapi.oam.createoamserviceendpoint.Output: - type: "object" - properties: - end-point: - description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.oam.deleteoamjob.Input: - type: "object" - properties: - job-id: - type: "string" - description: "none" - tapi.oam.deleteoamservice.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - tapi.oam.deleteoamserviceendpoint.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - o-sep-id: - type: "string" - description: "none" - tapi.oam.getmeg.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - tapi.oam.getmeg.Output: - type: "object" - properties: - meg: - description: "none" - $ref: "#/definitions/tapi.oam.Meg" - tapi.oam.getoamjob.Input: - type: "object" - properties: - job-id: - type: "string" - description: "none" - tapi.oam.getoamjob.Output: - type: "object" - properties: - oam-job: - description: "none" - $ref: "#/definitions/tapi.oam.OamJob" - tapi.oam.getoamservice.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - tapi.oam.getoamservice.Output: - type: "object" - properties: - service: - description: "none" - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.getoamserviceendpoint.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - o-sep-id: - type: "string" - description: "none" - tapi.oam.getoamserviceendpoint.Output: - type: "object" - properties: - end-point: - description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.oam.getoamservicelist.Output: - type: "object" - properties: - service: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.updateoamjob.Input: - type: "object" - properties: - job-id: - type: "string" - description: "none" - schedule: - type: "string" - description: "none" - oam-profile: - description: "none" - $ref: "#/definitions/tapi.oam.OamProfile" - state: - type: "string" - description: "none" - tapi.oam.updateoamjob.Output: - type: "object" - properties: - oam-job: - description: "none" - $ref: "#/definitions/tapi.oam.OamJob" - tapi.oam.updateoamservice.Input: - type: "object" - properties: - oam-constraint: - description: "none" - $ref: "#/definitions/tapi.oam.OamConstraint" - service-id: - type: "string" - description: "none" - state: - type: "string" - description: "none" - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.oam.updateoamservice.Output: - type: "object" - properties: - service: - description: "none" - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.updateoamserviceendpoint.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - o-sep-id: - type: "string" - description: "none" - state: - type: "string" - description: "none" - tapi.oam.updateoamserviceendpoint.Output: - type: "object" - properties: - end-point: - description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.path.computation.ComputeP2PPath: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.path.computation.computep2ppath.Output" - tapi.path.computation.ContextAugmentation3: - 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.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.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.PathOptimizationConstraint: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - traffic-interruption: - description: "none" - $ref: "#/definitions/tapi.common.DirectiveValue" - description: "none" - 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.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.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 - 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" - 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.TopologyConstraint: - type: "object" - properties: - include-node: - type: "array" - description: "This is a loose constraint - that is it is unordered and could\ - \ be a partial list" - items: - $ref: "#/definitions/tapi.topology.NodeRef" - exclude-link: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.LinkRef" - avoid-topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - exclude-path: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.path.computation.PathRef" - include-link: - type: "array" - description: "This is a loose constraint - that is it is unordered and could\ - \ be a partial list " - items: - $ref: "#/definitions/tapi.topology.LinkRef" - preferred-transport-layer: - type: "array" - description: "soft constraint requested by client to indicate the layer(s)\ - \ of transport connection that it prefers to carry the service. This could\ - \ be same as the service layer or one of the supported server layers" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - exclude-node: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRef" - include-topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - include-path: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.path.computation.PathRef" - 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.ContextAugmentation5: - type: "object" - properties: - topology-context: - description: "Augments the base TAPI Context with TopologyService information" - $ref: "#/definitions/tapi.topology.TopologyContext" - x-augmentation: - prefix: "tapi-topology" - namespace: "urn:onf:otcc:yang:tapi-topology" - tapi.topology.CostCharacteristic: - type: "object" - properties: - cost-value: - type: "string" - description: "The specific cost." - cost-algorithm: - type: "string" - description: "The cost may vary based upon some properties of the TopologicalEntity.\ - \ The rules for the variation are conveyed by the costAlgorithm." - cost-name: - type: "string" - description: "The cost characteristic will related to some aspect of the TopologicalEntity\ - \ (e.g. $ cost, routing weight). This aspect will be conveyed by the costName." - tapi.topology.ForwardingRule: - type: "string" - enum: - - "MAY_FORWARD_ACROSS_GROUP" - - "MUST_FORWARD_ACROSS_GROUP" - - "CANNOT_FORWARD_ACROSS_GROUP" - - "NO_STATEMENT_ON_FORWARDING" - tapi.topology.GetLinkDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.getlinkdetails.Output" - tapi.topology.GetNodeDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.getnodedetails.Output" - tapi.topology.GetNodeEdgePointDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Output" - tapi.topology.GetTopologyDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.gettopologydetails.Output" - tapi.topology.GetTopologyList: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.gettopologylist.Output" - tapi.topology.InterRuleGroup: - allOf: - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.RiskParameterPac" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - type: "object" - properties: - associated-node-rule-group: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - rule: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Rule" - description: "none" - tapi.topology.LatencyCharacteristic: - type: "object" - properties: - traffic-property-name: - type: "string" - description: "The identifier of the specific traffic property to which the\ - \ queuing latency applies." - jitter-characteristic: - type: "string" - description: "High frequency deviation from true periodicity of a signal and\ - \ therefore a small high rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." - fixed-latency-characteristic: - type: "string" - description: "A TopologicalEntity suffers delay caused by the realization\ - \ of the servers (e.g. distance related; FEC encoding etc.) along with some\ - \ client specific processing. This is the total average latency effect of\ - \ the TopologicalEntity" - wander-characteristic: - type: "string" - description: "Low frequency deviation from true periodicity of a signal and\ - \ therefore a small low rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." - queing-latency-characteristic: - type: "string" - description: "The specific queuing latency for the traffic property." - tapi.topology.LayerProtocolTransitionPac: - type: "object" - properties: - transitioned-layer-protocol-name: - type: "array" - description: "Provides the ordered structure of layer protocol transitions\ - \ encapsulated in the TopologicalEntity. The ordering relates to the LinkPort\ - \ role." - items: - type: "string" - tapi.topology.Link: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.LayerProtocolTransitionPac" - - $ref: "#/definitions/tapi.topology.RiskParameterPac" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - $ref: "#/definitions/tapi.topology.ValidationPac" - - type: "object" - properties: - layer-protocol-name: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - 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.NetworkTopologyService: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - description: "none" - tapi.topology.Node: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - type: "object" - properties: - layer-protocol-name: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - encap-topology: - description: "none" - $ref: "#/definitions/tapi.topology.TopologyRef" - 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.NodeRef: - allOf: - - $ref: "#/definitions/tapi.topology.TopologyRef" - - type: "object" - properties: - node-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:uuid" - description: "none" - tapi.topology.NodeRuleGroup: - allOf: - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.RiskParameterPac" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - type: "object" - properties: - inter-rule-group: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.InterRuleGroup" - rule: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Rule" - composed-rule-group: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - node-edge-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - description: "none" - tapi.topology.NodeRuleGroupRef: - allOf: - - $ref: "#/definitions/tapi.topology.NodeRef" - - type: "object" - properties: - node-rule-group-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-rule-group/tapi-topology:uuid" - description: "none" - tapi.topology.ProtectionType: - type: "string" - enum: - - "NO_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" - 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.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.RiskParameterPac: - type: "object" - properties: - risk-characteristic: - type: "array" - description: "A list of risk characteristics for consideration in an analysis\ - \ of shared risk. Each element of the list represents a specific risk consideration." - items: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - tapi.topology.Rule: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - override-priority: - type: "integer" - format: "int32" - description: "none" - forwarding-rule: - description: "none" - $ref: "#/definitions/tapi.topology.ForwardingRule" - rule-type: - description: "none" - $ref: "#/definitions/tapi.topology.RuleType" - description: "none" - tapi.topology.RuleType: - type: "string" - enum: - - "FORWARDING" - - "CAPACITY" - - "COST" - - "TIMING" - - "RISK" - - "GROUPING" - tapi.topology.Topology: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - layer-protocol-name: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - link: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Link" - node: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Node" - description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ - \ topological component which is used to effect forwarding of transport characteristic\ - \ information and offers the potential to enable forwarding. \r\n \ - \ At the lowest level of recursion, an FD (within a network element\ - \ (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ - \ multiple switch matrices (FDs). " - tapi.topology.TopologyContext: - type: "object" - properties: - nw-topology-service: - description: "none" - $ref: "#/definitions/tapi.topology.NetworkTopologyService" - topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Topology" - tapi.topology.TopologyRef: - type: "object" - properties: - topology-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:uuid" - tapi.topology.TransferCostPac: - type: "object" - properties: - cost-characteristic: - type: "array" - description: "The list of costs where each cost relates to some aspect of\ - \ the TopologicalEntity." - items: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - tapi.topology.TransferIntegrityPac: - type: "object" - properties: - error-characteristic: - type: "string" - description: "Describes the degree to which the signal propagated can be errored.\ - \ \r\n Applies to TDM systems as the errored signal will\ - \ be propagated and not packet as errored packets will be discarded." - unavailable-time-characteristic: - type: "string" - description: "Describes the duration for which there may be no valid signal\ - \ propagated." - server-integrity-process-characteristic: - type: "string" - description: "Describes the effect of any server integrity enhancement process\ - \ on the characteristics of the TopologicalEntity." - delivery-order-characteristic: - type: "string" - description: "Describes the degree to which packets will be delivered out\ - \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ - \ maintain strict order." - repeat-delivery-characteristic: - type: "string" - description: "Primarily applies to packet systems where a packet may be delivered\ - \ more than once (in fault recovery for example). \r\n \ - \ It can also apply to TDM where several frames may be received twice\ - \ due to switching in a system with a large differential propagation delay." - loss-characteristic: - type: "string" - description: "Describes the acceptable characteristic of lost packets where\ - \ loss may result from discard due to errors or overflow.\r\n \ - \ Applies to packet systems and not TDM (as for TDM errored signals\ - \ are propagated unless grossly errored and overflow/underflow turns into\ - \ timing slips)." - tapi.topology.TransferTimingPac: - type: "object" - properties: - latency-characteristic: - type: "array" - description: "The effect on the latency of a queuing process. This only has\ - \ significant effect for packet based systems and has a complex characteristic." - items: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - tapi.topology.ValidationMechanism: - type: "object" - properties: - layer-protocol-adjacency-validated: - type: "string" - description: "State of validatiion" - validation-mechanism: - type: "string" - description: "Name of mechanism used to validate adjacency" - validation-robustness: - type: "string" - description: "Quality of validation (i.e. how likely is the stated validation\ - \ to be invalid)" - tapi.topology.ValidationPac: - type: "object" - properties: - validation-mechanism: - type: "array" - description: "Provides details of the specific validation mechanism(s) used\ - \ to confirm the presence of an intended topologicalEntity." - items: - $ref: "#/definitions/tapi.topology.ValidationMechanism" - tapi.topology.getlinkdetails.Input: - type: "object" - properties: - link-id-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.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" diff --git a/OAS/tapi-odu@2018-12-10.yaml b/OAS/tapi-odu@2018-12-10.yaml deleted file mode 100644 index d6835120..00000000 --- a/OAS/tapi-odu@2018-12-10.yaml +++ /dev/null @@ -1,18648 +0,0 @@ ---- -swagger: "2.0" -info: - description: "tapi-oam,tapi-path-computation,tapi-connectivity,tapi-dsr,tapi-notification,tapi-topology,tapi-common,tapi-odu\ - \ API generated from yang definitions" - version: "1.0" - title: "tapi-oam,tapi-path-computation,tapi-connectivity,tapi-dsr,tapi-notification,tapi-topology,tapi-common,tapi-odu\ - \ API" -host: "localhost:1234" -consumes: -- "application/yang-data+json" -produces: -- "application/yang-data+json" -paths: - /data/context/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Context" - parameters: [] - responses: - 200: - description: "tapi.common.Context" - schema: - $ref: "#/definitions/tapi.common.Context" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.Context" - parameters: - - in: "body" - name: "tapi.common.Context.body-param" - description: "tapi.common.Context to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.Context" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.Context" - parameters: - - in: "body" - name: "tapi.common.Context.body-param" - description: "tapi.common.Context to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.Context" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.Context" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityContext" - parameters: [] - responses: - 200: - description: "tapi.connectivity.ConnectivityContext" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityContext" - 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.ConnectivityContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityContext" - 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.ConnectivityContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connection={uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.Connection" - parameters: - - name: "uuid" - in: "path" - description: "Id of connection" - required: true - type: "string" - responses: - 200: - description: "tapi.connectivity.Connection" - schema: - $ref: "#/definitions/tapi.connectivity.Connection" - 400: - description: "Internal error" - ? /data/context/connectivity-context/connection={uuid}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" - 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.ConnectionEndPointRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/lower-connection={connection-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionRef" - 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.ConnectionRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - 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.NameAndValue" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/route={local-id}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.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.Route" - schema: - $ref: "#/definitions/tapi.connectivity.Route" - 400: - description: "Internal error" - ? /data/context/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" - description: "returns tapi.connectivity.ConnectionEndPointRef" - 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.ConnectionEndPointRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/route={local-id}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - 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.NameAndValue" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/supported-client-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" - 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.LinkRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.SwitchControl" - 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.SwitchControl" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - 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.NameAndValue" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/resilience-type/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of connection" - required: true - type: "string" - - name: "switch-control-uuid" - in: "path" - description: "Id of switch-control" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" - ? /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/sub-switch-control={connection-uuid},{sub-switch-control-switch-control-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.SwitchControlRef" - 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.SwitchControlRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/switch={local-id}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.Switch" - 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.Switch" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/switch={local-id}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - 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.NameAndValue" - 400: - description: "Internal error" - ? /data/context/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" - description: "returns tapi.connectivity.ConnectionEndPointRef" - 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.ConnectionEndPointRef" - 400: - description: "Internal error" - ? /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/switch={local-id}/selected-route={connection-uuid},{route-local-id}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.RouteRef" - 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.RouteRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityService" - 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.ConnectivityService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityService" - 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.ConnectivityService" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityService" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityService.body-param" - description: "tapi.connectivity.ConnectivityService to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityService" - 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.ConnectivityService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityService" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/avoid-topology={topology-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of avoid-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/connection={connection-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionRef" - 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.ConnectionRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/coroute-inclusion/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceRef" - 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.ConnectivityServiceRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceRef" - 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.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/cost-characteristic/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.CostCharacteristic" - 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.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/diversity-exclusion/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" - 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.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/diversity-exclusion={connectivity-service-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "connectivity-service-uuid" - in: "path" - description: "Id of diversity-exclusion" - required: true - type: "string" - responses: - 200: - description: "tapi.connectivity.ConnectivityServiceRef" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "connectivity-service-uuid" - in: "path" - description: "Id of diversity-exclusion" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceRef" - 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.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "connectivity-service-uuid" - in: "path" - description: "Id of diversity-exclusion" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPoint to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceEndPoint" - 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.ConnectivityServiceEndPoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPoint.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPoint to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceEndPoint" - 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.ConnectivityServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.Capacity" - 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.Capacity" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.Capacity" - 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.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.BandwidthProfile" - 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.BandwidthProfile" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/total-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.connectivity.ConnectionEndPointRef" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - 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.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/service-interface-point/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.ServiceInterfacePointRef" - 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.ServiceInterfacePointRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.ServiceInterfacePointRef" - 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.ServiceInterfacePointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.ServiceInterfacePointRef" - 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.ServiceInterfacePointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-path={path-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of exclude-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-path={path-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of include-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-topology={topology-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/latency-characteristic/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.LatencyCharacteristic" - 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.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/name/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.Capacity" - 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.Capacity" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.Capacity" - 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.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.BandwidthProfile" - 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.BandwidthProfile" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/total-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/resilience-type/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.ResilienceType" - 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.ResilienceType" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.ResilienceType" - parameters: - - name: "uuid" - 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.ResilienceType" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/risk-diversity-characteristic/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/risk-diversity-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/schedule/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.TimeRange" - 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.TimeRange" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.TimeRange" - 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.TimeRange" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.TimeRange" - parameters: - - name: "uuid" - 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.TimeRange" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.TimeRange" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationContext" - parameters: [] - responses: - 200: - description: "tapi.notification.NotificationContext" - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationContext" - parameters: - - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationContext" - parameters: - - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription/: - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" - parameters: - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NotificationSubscriptionService" - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NotificationChannel" - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.Notification" - schema: - $ref: "#/definitions/tapi.notification.Notification" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of additional-info" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of changed-attributes" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NameAndValueChange" - schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of target-object-name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/tca-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.SubscriptionFilter" - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notification={uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.Notification" - schema: - $ref: "#/definitions/tapi.notification.Notification" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/additional-info={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of additional-info" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of changed-attributes" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NameAndValueChange" - schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of target-object-name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/tca-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" - /data/context/oam-context/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamContext" - parameters: [] - responses: - 200: - description: "tapi.oam.OamContext" - schema: - $ref: "#/definitions/tapi.oam.OamContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamContext" - parameters: - - in: "body" - name: "tapi.oam.context.OamContext.body-param" - description: "tapi.oam.OamContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamContext" - parameters: - - in: "body" - name: "tapi.oam.context.OamContext.body-param" - description: "tapi.oam.OamContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/meg={uuid}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.oamcontext.Meg" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.oamcontext.Meg" - schema: - $ref: "#/definitions/tapi.oam.oamcontext.Meg" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.meg.Mep" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.meg.Mep" - schema: - $ref: "#/definitions/tapi.oam.meg.Mep" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/odu-connection-end-point-spec/: - get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduConnectionEndPointSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduConnectionEndPointSpec" - schema: - $ref: "#/definitions/tapi.odu.OduConnectionEndPointSpec" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/odu-connection-end-point-spec/odu-common/: - get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduCommonPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduCommonPac" - schema: - $ref: "#/definitions/tapi.odu.OduCommonPac" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/odu-connection-end-point-spec/odu-ctp/: - get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduCtpPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduCtpPac" - schema: - $ref: "#/definitions/tapi.odu.OduCtpPac" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/odu-connection-end-point-spec/odu-protection/: - get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduProtectionPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduProtectionPac" - schema: - $ref: "#/definitions/tapi.odu.OduProtectionPac" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/odu-connection-end-point-spec/odu-term-and-adapter/: - get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduTerminationAndClientAdaptationPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduTerminationAndClientAdaptationPac" - schema: - $ref: "#/definitions/tapi.odu.OduTerminationAndClientAdaptationPac" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/odu-connection-end-point-spec/odu-term-and-adapter/accepted-payload-type/: - get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduPayloadType" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduPayloadType" - schema: - $ref: "#/definitions/tapi.odu.OduPayloadType" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.meg.Mip" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.meg.Mip" - schema: - $ref: "#/definitions/tapi.oam.meg.Mip" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/: - get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduMipSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduMipSpec" - schema: - $ref: "#/definitions/tapi.odu.OduMipSpec" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-defect/: - get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduDefectPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduDefectPac" - schema: - $ref: "#/definitions/tapi.odu.OduDefectPac" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-mip/: - get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduMipPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduMipPac" - schema: - $ref: "#/definitions/tapi.odu.OduMipPac" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-mip/deg-thr/: - get: - tags: - - "tapi-odu" - description: "returns tapi.odu.DegThr" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.DegThr" - schema: - $ref: "#/definitions/tapi.odu.DegThr" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-ncm/: - get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduNcmPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduNcmPac" - schema: - $ref: "#/definitions/tapi.odu.OduNcmPac" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-pm/: - get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduPmPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduPmPac" - schema: - $ref: "#/definitions/tapi.odu.OduPmPac" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-pm/uas/: - get: - tags: - - "tapi-odu" - description: "returns tapi.odu.UasChoice" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.UasChoice" - schema: - $ref: "#/definitions/tapi.odu.UasChoice" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-tcm/: - get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduTcmMipPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduTcmMipPac" - schema: - $ref: "#/definitions/tapi.odu.OduTcmMipPac" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/oam-context/oam-job/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamJob" - parameters: - - in: "body" - name: "tapi.oam.OamJob.body-param" - description: "tapi.oam.OamJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamJob" - schema: - $ref: "#/definitions/tapi.oam.OamJob" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamJob.body-param" - description: "tapi.oam.OamJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamJob.body-param" - description: "tapi.oam.OamJob to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/oam-profile/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamProfileRef" - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/oam-service-end-point/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/oam-service-end-point={oam-service-uuid},{oam-service-end-point-local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - name: "oam-service-end-point-local-id" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamServiceEndPointRef" - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - name: "oam-service-end-point-local-id" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - name: "oam-service-end-point-local-id" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - name: "oam-service-end-point-local-id" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.PmCurrentData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.PmCurrentData" - schema: - $ref: "#/definitions/tapi.oam.PmCurrentData" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/elapsed-time/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimeInterval" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimeInterval" - schema: - $ref: "#/definitions/tapi.common.TimeInterval" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/elapsed-time/period={unit}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "unit" - in: "path" - description: "Id of period" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/granularity-period/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.PmHistoryData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.PmHistoryData" - schema: - $ref: "#/definitions/tapi.oam.PmHistoryData" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/granularity-period/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/name={value-name}/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/schedule/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimeRange" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimeRange" - schema: - $ref: "#/definitions/tapi.common.TimeRange" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.TimeRange" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.TimeRange" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.TimeRange" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.TimeRange" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.TimeRange" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamProfile" - parameters: - - in: "body" - name: "tapi.oam.OamProfile.body-param" - description: "tapi.oam.OamProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamProfile" - schema: - $ref: "#/definitions/tapi.oam.OamProfile" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfile.body-param" - description: "tapi.oam.OamProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfile.body-param" - description: "tapi.oam.OamProfile to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.PmBinData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmBinData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.PmBinData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.PmBinData" - schema: - $ref: "#/definitions/tapi.oam.PmBinData" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.PmBinData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmBinData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.PmBinData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmBinData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.PmBinData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/granularity-period/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmThresholdData.body-param" - description: "tapi.oam.PmThresholdData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.PmThresholdData" - schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmThresholdData.body-param" - description: "tapi.oam.PmThresholdData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmThresholdData.body-param" - description: "tapi.oam.PmThresholdData to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/granularity-period/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamService" - parameters: - - in: "body" - name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamService" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamService" - schema: - $ref: "#/definitions/tapi.oam.OamService" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamService" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamService" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamService" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamServiceEndPoint" - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/connectivity-service-end-point/: - get: - tags: - - "tapi-oam" - description: "returns tapi.connectivity.ConnectivityServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.connectivity.ConnectivityServiceEndPointRef" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.connectivity.ConnectivityServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.connectivity.ConnectivityServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/mep/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MepRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MepRef" - schema: - $ref: "#/definitions/tapi.oam.MepRef" - 400: - description: "Internal error" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/mip/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MipRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MipRef" - schema: - $ref: "#/definitions/tapi.oam.MipRef" - 400: - description: "Internal error" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/service-interface-point/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePointRef.body-param" - description: "tapi.common.ServiceInterfacePointRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePointRef.body-param" - description: "tapi.common.ServiceInterfacePointRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/meg/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MegRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MegRef" - schema: - $ref: "#/definitions/tapi.oam.MegRef" - 400: - description: "Internal error" - /data/context/oam-context/oam-service={uuid}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/oam-profile/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamProfileRef" - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathComputationContext" - parameters: [] - responses: - 200: - description: "tapi.path.computation.PathComputationContext" - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationContext" - parameters: - - in: "body" - name: "tapi.path.computation.PathComputationContext.body-param" - description: "tapi.path.computation.PathComputationContext to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathComputationContext" - parameters: - - in: "body" - name: "tapi.path.computation.PathComputationContext.body-param" - description: "tapi.path.computation.PathComputationContext to be added or\ - \ updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathComputationContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationService" - parameters: - - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathComputationService" - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - 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.PathComputationService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - 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.PathServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathServiceEndPoint" - schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.Capacity" - 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.Capacity" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.Capacity" - 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.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.Capacity" - 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.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.BandwidthProfile" - 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.BandwidthProfile" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/total-size/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/service-interface-point/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathObjectiveFunction" - schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathObjectiveFunction.body-param" - description: "tapi.path.computation.PathObjectiveFunction to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathObjectiveFunction.body-param" - description: "tapi.path.computation.PathObjectiveFunction to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathOptimizationConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathOptimizationConstraint.body-param" - description: "tapi.path.computation.PathOptimizationConstraint to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathOptimizationConstraint.body-param" - description: "tapi.path.computation.PathOptimizationConstraint to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.RoutingConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.RoutingConstraint.body-param" - description: "tapi.path.computation.RoutingConstraint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.RoutingConstraint.body-param" - description: "tapi.path.computation.RoutingConstraint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.TopologyConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.TopologyConstraint.body-param" - description: "tapi.path.computation.TopologyConstraint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.TopologyConstraint.body-param" - description: "tapi.path.computation.TopologyConstraint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/avoid-topology={topology-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of avoid-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of exclude-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of include-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-topology={topology-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.Path" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.Path" - schema: - $ref: "#/definitions/tapi.path.computation.Path" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.RoutingConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/service-interface-point/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePoint" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/available-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/total-potential-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyContext" - parameters: [] - responses: - 200: - description: "tapi.topology.TopologyContext" - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-topology" - description: "creates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.context.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-topology" - description: "creates or updates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.context.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-topology" - description: "removes tapi.topology.TopologyContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/topology-context/nw-topology-service/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NetworkTopologyService" - parameters: [] - responses: - 200: - description: "tapi.topology.NetworkTopologyService" - schema: - $ref: "#/definitions/tapi.topology.NetworkTopologyService" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "topology-uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Topology" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Topology" - schema: - $ref: "#/definitions/tapi.topology.Topology" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Link" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Link" - schema: - $ref: "#/definitions/tapi.topology.Link" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/resilience-type/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ValidationMechanism" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "validation-mechanism" - in: "path" - description: "Id of validation-mechanism" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ValidationMechanism" - schema: - $ref: "#/definitions/tapi.topology.ValidationMechanism" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.topology.Node" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.topology.Node" - schema: - $ref: "#/definitions/tapi.topology.topology.Node" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroup" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroup" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-rule-group-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroupRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.InterRuleGroup" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.InterRuleGroup" - schema: - $ref: "#/definitions/tapi.topology.InterRuleGroup" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-rule-group-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroupRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Rule" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Rule" - schema: - $ref: "#/definitions/tapi.topology.Rule" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Rule" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Rule" - schema: - $ref: "#/definitions/tapi.topology.Rule" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.node.OwnedNodeEdgePoint" - parameters: - - name: "uuid" - 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.OwnedNodeEdgePoint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - 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.context.topologycontext.topology.node.ownednodeedgepoint.CepList" - schema: - $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ceplist.ConnectionEndPoint" - parameters: - - name: "uuid" - 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.ceplist.ConnectionEndPoint" - schema: - $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/aggregated-connection-end-point={topology-uuid},{aggregated-connection-end-point-node-uuid},{node-edge-point-uuid},{aggregated-connection-end-point-connection-end-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" - parameters: - - name: "uuid" - 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.ConnectionEndPointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/client-node-edge-point={topology-uuid},{client-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - 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.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MepMipList" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MepMipList" - schema: - $ref: "#/definitions/tapi.oam.MepMipList" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mep={meg-uuid},{mep-local-id}/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MepRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "meg-uuid" - in: "path" - description: "Id of mep" - required: true - type: "string" - - name: "mep-local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MepRef" - schema: - $ref: "#/definitions/tapi.oam.MepRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mip={meg-uuid},{mip-local-id}/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MipRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "meg-uuid" - in: "path" - description: "Id of mip" - required: true - type: "string" - - name: "mip-local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MipRef" - schema: - $ref: "#/definitions/tapi.oam.MipRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/name={value-name}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/ - : get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduConnectionEndPointSpec" - parameters: - - name: "uuid" - 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.odu.OduConnectionEndPointSpec" - schema: - $ref: "#/definitions/tapi.odu.OduConnectionEndPointSpec" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-common/ - : get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduCommonPac" - parameters: - - name: "uuid" - 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.odu.OduCommonPac" - schema: - $ref: "#/definitions/tapi.odu.OduCommonPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-ctp/ - : get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduCtpPac" - parameters: - - name: "uuid" - 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.odu.OduCtpPac" - schema: - $ref: "#/definitions/tapi.odu.OduCtpPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-protection/ - : get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduProtectionPac" - parameters: - - name: "uuid" - 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.odu.OduProtectionPac" - schema: - $ref: "#/definitions/tapi.odu.OduProtectionPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-term-and-adapter/ - : get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduTerminationAndClientAdaptationPac" - parameters: - - name: "uuid" - 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.odu.OduTerminationAndClientAdaptationPac" - schema: - $ref: "#/definitions/tapi.odu.OduTerminationAndClientAdaptationPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-term-and-adapter/accepted-payload-type/ - : get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduPayloadType" - parameters: - - name: "uuid" - 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.odu.OduPayloadType" - schema: - $ref: "#/definitions/tapi.odu.OduPayloadType" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/parent-node-edge-point/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "service-interface-point-uuid" - in: "path" - description: "Id of mapped-service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/odu-node-edge-point-spec/ - : get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduNodeEdgePointSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduNodeEdgePointSpec" - schema: - $ref: "#/definitions/tapi.odu.OduNodeEdgePointSpec" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/odu-node-edge-point-spec/odu-pool/ - : get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduPoolPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduPoolPac" - schema: - $ref: "#/definitions/tapi.odu.OduPoolPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /operations/compute-p-2-p-path/: - post: - tags: - - "tapi-path-computation" - parameters: - - in: "body" - name: "tapi.path.computation.computep2ppath.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.path.computation.computep2ppath.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.path.computation.ComputeP2PPath" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-connectivity-service/: - post: - tags: - - "tapi-connectivity" - parameters: - - in: "body" - name: "tapi.connectivity.createconnectivityservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.connectivity.createconnectivityservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.connectivity.CreateConnectivityService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-notification-subscription-service/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.CreateNotificationSubscriptionService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-oam-job/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.createoamjob.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.createoamjob.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.CreateOamJob" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-oam-service-end-point/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.createoamserviceendpoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.createoamserviceendpoint.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.CreateOamServiceEndPoint" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-oam-service/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.createoamservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.createoamservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.CreateOamService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/delete-connectivity-service/: - post: - tags: - - "tapi-connectivity" - 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/delete-notification-subscription-service/: - post: - tags: - - "tapi-notification" - 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/delete-oam-job/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.deleteoamjob.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.deleteoamjob.Input" - responses: - 201: - description: "No response" - 400: - description: "Internal error" - /operations/delete-oam-service-end-point/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.deleteoamserviceendpoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.deleteoamserviceendpoint.Input" - responses: - 201: - description: "No response" - 400: - description: "Internal error" - /operations/delete-oam-service/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.deleteoamservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.deleteoamservice.Input" - responses: - 201: - description: "No response" - 400: - description: "Internal error" - /operations/delete-p-2-p-path/: - post: - tags: - - "tapi-path-computation" - 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/get-connection-details/: - post: - tags: - - "tapi-connectivity" - 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/get-connection-end-point-details/: - post: - tags: - - "tapi-connectivity" - 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/get-connectivity-service-details/: - post: - tags: - - "tapi-connectivity" - 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/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/get-link-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.getlinkdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.getlinkdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetLinkDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-meg/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.getmeg.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.getmeg.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.GetMeg" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-node-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.getnodedetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.getnodedetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetNodeDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-node-edge-point-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.getnodeedgepointdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetNodeEdgePointDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-list/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.getnotificationlist.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.getnotificationlist.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-subscription-service-details/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-subscription-service-list/: - post: - tags: - - "tapi-notification" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-oam-job/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.getoamjob.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.getoamjob.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.GetOamJob" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-oam-service-end-point/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.getoamserviceendpoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.getoamserviceendpoint.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.GetOamServiceEndPoint" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-oam-service-list/: - post: - tags: - - "tapi-oam" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.GetOamServiceList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-oam-service/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.getoamservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.getoamservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.GetOamService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-service-interface-point-details/: - post: - tags: - - "tapi-common" - parameters: - - in: "body" - name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.common.GetServiceInterfacePointDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-service-interface-point-list/: - post: - tags: - - "tapi-common" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.common.GetServiceInterfacePointList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-supported-notification-types/: - post: - tags: - - "tapi-notification" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetSupportedNotificationTypes" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-topology-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.gettopologydetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.gettopologydetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetTopologyDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-topology-list/: - post: - tags: - - "tapi-topology" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetTopologyList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/optimize-p-2-p-path/: - post: - tags: - - "tapi-path-computation" - 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/update-connectivity-service/: - post: - tags: - - "tapi-connectivity" - 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/update-notification-subscription-service/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.UpdateNotificationSubscriptionService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-oam-job/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.updateoamjob.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.updateoamjob.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.UpdateOamJob" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-oam-service-end-point/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.updateoamserviceendpoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.updateoamserviceendpoint.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.UpdateOamServiceEndPoint" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-oam-service/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.updateoamservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.updateoamservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.UpdateOamService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-service-interface-point/: - post: - tags: - - "tapi-common" - parameters: - - in: "body" - name: "tapi.common.updateserviceinterfacepoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.common.updateserviceinterfacepoint.Input" - responses: - 201: - description: "No response" - 400: - description: "Internal error" -definitions: - tapi.common.AdminStatePac: - type: "object" - properties: - operational-state: - description: "none" - $ref: "#/definitions/tapi.common.OperationalState" - lifecycle-state: - description: "none" - $ref: "#/definitions/tapi.common.LifecycleState" - administrative-state: - description: "none" - $ref: "#/definitions/tapi.common.AdministrativeState" - tapi.common.AdministrativeState: - type: "string" - enum: - - "LOCKED" - - "UNLOCKED" - tapi.common.BandwidthProfile: - type: "object" - properties: - committed-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - coupling-flag: - type: "boolean" - description: "none" - default: false - bw-profile-type: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfileType" - peak-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - committed-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - peak-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - color-aware: - type: "boolean" - description: "none" - default: false - tapi.common.BandwidthProfileType: - type: "string" - enum: - - "MEF_10.x" - - "RFC_2697" - - "RFC_2698" - - "RFC_4115" - tapi.common.Capacity: - type: "object" - properties: - bandwidth-profile: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfile" - total-size: - description: "Total capacity of the TopologicalEntity in MB/s. In case of\ - \ bandwidthProfile, this is expected to same as the committedInformationRate." - $ref: "#/definitions/tapi.common.CapacityValue" - tapi.common.CapacityPac: - type: "object" - properties: - available-capacity: - description: "Capacity available to be assigned." - $ref: "#/definitions/tapi.common.Capacity" - total-potential-capacity: - description: "An optimistic view of the capacity of the TopologicalEntity\ - \ assuming that any shared capacity is available to be taken." - $ref: "#/definitions/tapi.common.Capacity" - tapi.common.CapacityUnit: - type: "string" - enum: - - "TB" - - "TBPS" - - "GB" - - "GBPS" - - "MB" - - "MBPS" - - "KB" - - "KBPS" - - "GHz" - - "MHz" - tapi.common.CapacityValue: - type: "object" - properties: - value: - type: "integer" - format: "int32" - description: "none" - unit: - description: "none" - $ref: "#/definitions/tapi.common.CapacityUnit" - tapi.common.Context: - allOf: - - $ref: "#/definitions/tapi.common.TapiContext" - - $ref: "#/definitions/tapi.connectivity.ContextAugmentation4" - - $ref: "#/definitions/tapi.notification.ContextAugmentation2" - - $ref: "#/definitions/tapi.oam.ContextAugmentation1" - - $ref: "#/definitions/tapi.path.computation.ContextAugmentation3" - - $ref: "#/definitions/tapi.topology.ContextAugmentation5" - 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.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" - description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ - \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ - \ circuit and packet forms." - tapi.common.ServiceInterfacePointRef: - type: "object" - properties: - service-interface-point-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-common:service-interface-point/tapi-common:uuid" - tapi.common.TapiContext: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - service-interface-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - description: "The Network Control Domain (NCD) object class represents the scope\ - \ of control that a particular SDN controller has with respect to a particular\ - \ network, (i.e., encompassing a designated set of interconnected (virtual)\ - \ network elements)." - tapi.common.TerminationDirection: - type: "string" - enum: - - "BIDIRECTIONAL" - - "SINK" - - "SOURCE" - - "UNDEFINED_OR_UNKNOWN" - tapi.common.TerminationPac: - type: "object" - properties: - termination-direction: - description: "The overall directionality of the LP. \r\n \ - \ - A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ - \ - A SINK LP can only contain elements with SINK flows\ - \ or CONTRA_DIRECTION_SOURCE flows\r\n - A SOURCE LP\ - \ can only contain SOURCE flows or CONTRA_DIRECTION_SINK flows" - $ref: "#/definitions/tapi.common.TerminationDirection" - termination-state: - description: "Indicates whether the layer is terminated and if so how." - $ref: "#/definitions/tapi.common.TerminationState" - tapi.common.TerminationState: - type: "string" - enum: - - "LP_CAN_NEVER_TERMINATE" - - "LT_NOT_TERMINATED" - - "TERMINATED_SERVER_TO_CLIENT_FLOW" - - "TERMINATED_CLIENT_TO_SERVER_FLOW" - - "TERMINATED_BIDIRECTIONAL" - - "LT_PERMENANTLY_TERMINATED" - - "TERMINATION_STATE_UNKNOWN" - tapi.common.TimeInterval: - type: "object" - properties: - period: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.TimePeriod" - tapi.common.TimePeriod: - type: "object" - properties: - value: - type: "integer" - format: "int32" - description: "none" - unit: - description: "none" - $ref: "#/definitions/tapi.common.TimeUnit" - tapi.common.TimeRange: - type: "object" - properties: - end-time: - type: "string" - description: "none" - start-time: - type: "string" - description: "none" - tapi.common.TimeUnit: - type: "string" - enum: - - "YEARS" - - "MONTHS" - - "DAYS" - - "HOURS" - - "MINUTES" - - "SECONDS" - - "MILLISECONDS" - - "MICROSECONDS" - - "NANOSECONDS" - - "PICOSECONDS" - 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.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" - 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" - 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.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.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" - 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" - coroute-inclusion: - description: "none" - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" - tapi.connectivity.ConnectivityContext: - type: "object" - properties: - connectivity-service: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ConnectivityService" - connection: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.Connection" - tapi.connectivity.ConnectivityService: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" - - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - - type: "object" - properties: - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" - connection: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ConnectionRef" - description: "The ForwardingConstruct (FC) object class models enabled potential\ - \ for forwarding between two or more LTPs and like the LTP supports any transport\ - \ protocol including all circuit and packet forms.\r\n At the\ - \ lowest level of recursion, a FC represents a cross-connection within an\ - \ NE." - tapi.connectivity.ConnectivityServiceEndPoint: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $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" - 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" - 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.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.ContextAugmentation4: - 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.context.topologycontext.topology.node.ownednodeedgepoint.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.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" - description: "The FC Route (FcRoute) object class models the individual routes\ - \ of an FC. \r\n The route of an FC object is represented by\ - \ a list of FCs at a lower level. \r\n Note that depending\ - \ on the service supported by an FC, an the FC can have multiple routes." - 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.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.UpdateConnectivityService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.connectivity.updateconnectivityservice.Output" - tapi.connectivity.ceplist.ConnectionEndPoint: - allOf: - - $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" - - $ref: "#/definitions/tapi.oam.ConnectionEndPointAugmentation2" - - $ref: "#/definitions/tapi.odu.ConnectionEndPointAugmentation1" - tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList: - allOf: - - type: "object" - properties: - connection-end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" - description: "none" - 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.ContextAugmentation2: - 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.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.NotificationContext: - type: "object" - properties: - notif-subscription: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - notification: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.Notification" - tapi.notification.NotificationSubscriptionService: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - notification: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.Notification" - notification-channel: - description: "none" - $ref: "#/definitions/tapi.notification.NotificationChannel" - subscription-state: - description: "none" - $ref: "#/definitions/tapi.notification.SubscriptionState" - supported-object-types: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.ObjectType" - supported-notification-types: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.NotificationType" - subscription-filter: - description: "none" - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - description: "none" - tapi.notification.NotificationType: - type: "string" - enum: - - "OBJECT_CREATION" - - "OBJECT_DELETION" - - "ATTRIBUTE_VALUE_CHANGE" - - "ALARM_EVENT" - - "THRESHOLD_CROSSING_ALERT" - tapi.notification.ObjectType: - type: "string" - enum: - - "TOPOLOGY" - - "NODE" - - "LINK" - - "CONNECTION" - - "PATH" - - "CONNECTIVITY_SERVICE" - - "VIRTUAL_NETWORK_SERVICE" - - "PATH_COMPUTATION_SERVICE" - - "NODE_EDGE_POINT" - - "SERVICE_INTERFACE_POINT" - - "CONNECTION_END_POINT" - - "MAINTENANCE_ENTITY_GROUP" - - "MAINTENANCE_ENTITY" - - "MEG_END_POINT" - - "MEG_INTERMEDIATE_POINT" - - "SWITCH_CONTROL" - - "SWITCH" - - "ROUTE" - - "NODE_RULE_GROUP" - - "INTER_RULE_GROUP" - - "RULE" - - "OAM_JOB" - tapi.notification.PerceivedSeverityType: - type: "string" - enum: - - "CRITICAL" - - "MAJOR" - - "MINOR" - - "WARNING" - - "CLEARED" - tapi.notification.PerceivedTcaSeverity: - type: "string" - enum: - - "WARNING" - - "CLEAR" - tapi.notification.ServiceAffecting: - type: "string" - enum: - - "SERVICE_AFFECTING" - - "NOT_SERVICE_AFFECTING" - - "UNKNOWN" - 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.SubscriptionState: - type: "string" - enum: - - "SUSPENDED" - - "ACTIVE" - tapi.notification.TcaInfo: - type: "object" - properties: - threshold-crossing: - description: "none" - $ref: "#/definitions/tapi.notification.ThresholdCrossingType" - threshold-parameter: - type: "string" - description: "none" - is-transient: - type: "boolean" - description: "none" - default: false - threshold-value: - type: "integer" - format: "int32" - description: "none" - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedTcaSeverity" - suspect-interval-flag: - type: "boolean" - description: "none" - default: false - measurement-interval: - type: "string" - description: "none" - tapi.notification.ThresholdCrossingType: - type: "string" - enum: - - "THRESHOLD_ABOVE" - - "THRESHOLD_BELOW" - - "CLEARED" - tapi.notification.UpdateNotificationSubscriptionService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Output" - tapi.notification.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.oam.ConnectionEndPointAugmentation2: - type: "object" - properties: - mep-mip-list: - description: "none" - $ref: "#/definitions/tapi.oam.MepMipList" - x-augmentation: - prefix: "tapi-oam" - namespace: "urn:onf:otcc:yang:tapi-oam" - tapi.oam.ContextAugmentation1: - type: "object" - properties: - oam-context: - description: "Augments the base TAPI Context with OamService information" - $ref: "#/definitions/tapi.oam.OamContext" - x-augmentation: - prefix: "tapi-oam" - namespace: "urn:onf:otcc:yang:tapi-oam" - tapi.oam.CreateOamJob: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.createoamjob.Output" - tapi.oam.CreateOamService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.createoamservice.Output" - tapi.oam.CreateOamServiceEndPoint: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.createoamserviceendpoint.Output" - tapi.oam.GetMeg: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.getmeg.Output" - tapi.oam.GetOamJob: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.getoamjob.Output" - tapi.oam.GetOamService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.getoamservice.Output" - tapi.oam.GetOamServiceEndPoint: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.getoamserviceendpoint.Output" - tapi.oam.GetOamServiceList: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.getoamservicelist.Output" - tapi.oam.Meg: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.common.OperationalStatePac" - - type: "object" - properties: - meg-identifier: - type: "string" - description: "none" - meg-level: - type: "integer" - format: "int32" - description: "none" - mip: - type: "array" - description: "ME may 0, 1, or more MIPs" - items: - $ref: "#/definitions/tapi.oam.Mip" - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - mep: - type: "array" - description: "1. ME may have 0 MEPs (case of transit domains where at least\ - \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case\ - \ of edge domaind, where the peer MEP is ouside the managed domain)\r\n\ - \ 3. ME may have 2 MEPs" - items: - $ref: "#/definitions/tapi.oam.Mep" - direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" - description: "none" - tapi.oam.MegRef: - type: "object" - properties: - meg-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:uuid" - tapi.oam.Mep: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - $ref: "#/definitions/tapi.common.OperationalStatePac" - - type: "object" - properties: - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - peer-mep-identifier: - type: "array" - description: "none" - items: - type: "string" - mep-identifier: - type: "string" - description: "none" - direction: - description: "none" - $ref: "#/definitions/tapi.common.TerminationDirection" - description: "none" - tapi.oam.MepMipList: - type: "object" - properties: - mip: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.MipRef" - mep: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.MepRef" - tapi.oam.MepRef: - allOf: - - $ref: "#/definitions/tapi.oam.MegRef" - - type: "object" - properties: - mep-local-id: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:mep/tapi-oam:local-id" - description: "none" - tapi.oam.Mip: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - description: "none" - tapi.oam.MipRef: - allOf: - - $ref: "#/definitions/tapi.oam.MegRef" - - type: "object" - properties: - mip-local-id: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:mip/tapi-oam:local-id" - description: "none" - tapi.oam.OamConstraint: - type: "object" - properties: - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - meg-level: - type: "integer" - format: "int32" - description: "none" - direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" - tapi.oam.OamContext: - type: "object" - properties: - oam-service: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamService" - oam-profile: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamProfile" - oam-job: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamJob" - meg: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.Meg" - tapi.oam.OamJob: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - schedule: - description: "none" - $ref: "#/definitions/tapi.common.TimeRange" - oam-profile: - description: "none" - $ref: "#/definitions/tapi.oam.OamProfileRef" - pm-current-data: - type: "array" - description: "Granularity period of the CurrentData identifies the specific\ - \ CurrentData instance in the scope of this OamJob.\r\n \ - \ For example, typically at least\r\n one 15min\ - \ and\r\n one 24hr;\r\n optionally\ - \ one additional configurable (< 15min)" - items: - $ref: "#/definitions/tapi.oam.PmCurrentData" - creation-time: - type: "string" - description: "none" - oam-service-end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" - oam-job-type: - type: "string" - description: "none" - description: "none" - tapi.oam.OamProfile: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - pm-threshold-data: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.PmThresholdData" - pm-bin-data: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.PmBinData" - description: "none" - tapi.oam.OamProfileRef: - type: "object" - properties: - oam-profile-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-profile/tapi-oam:uuid" - tapi.oam.OamService: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.oam.OamConstraint" - - type: "object" - properties: - oam-profile: - description: "none" - $ref: "#/definitions/tapi.oam.OamProfileRef" - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - meg: - description: "none" - $ref: "#/definitions/tapi.oam.MegRef" - description: "none" - tapi.oam.OamServiceEndPoint: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - peer-mep-identifier: - type: "array" - description: "This attribute models the MI_PeerMEP_ID[i] defined in G.8021\ - \ and configured as specified in G.8051. It provides the identifiers of\ - \ the MEPs which are peer to the subject MEP.\r\n This\ - \ attribute is not specified in case the OSEP relates to the provisioing\ - \ of an MIP.\r\n In case of P2P, there is only one\ - \ peer" - items: - type: "string" - connectivity-service-end-point: - description: "none" - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" - mip: - description: "none" - $ref: "#/definitions/tapi.oam.MipRef" - service-interface-point: - description: "none" - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - mep: - description: "none" - $ref: "#/definitions/tapi.oam.MepRef" - mep-identifier: - type: "string" - description: "This attribute contains the identifier of the MEP.\r\n \ - \ This attribute is empty in case the OSEP relates to\ - \ the provisioing of an MIP.\r\n " - direction: - description: "none" - $ref: "#/definitions/tapi.common.PortDirection" - description: "none" - tapi.oam.OamServiceEndPointRef: - allOf: - - $ref: "#/definitions/tapi.oam.OamServiceRef" - - type: "object" - properties: - oam-service-end-point-local-id: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:end-point/tapi-oam:local-id" - description: "none" - tapi.oam.OamServiceRef: - type: "object" - properties: - oam-service-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:uuid" - tapi.oam.PmBinData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - description: "none" - tapi.oam.PmCurrentData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - elapsed-time: - description: "none" - $ref: "#/definitions/tapi.common.TimeInterval" - pm-history-data: - type: "array" - description: "in case of 24hr Current Data, at least 1 History Data.\r\n\ - \ In case of 15min Current Data, at least 16 History\ - \ Data.\r\n In case of <15min, the number of History\ - \ Data shall be able to cover a span of 4 hours." - items: - $ref: "#/definitions/tapi.oam.PmHistoryData" - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - suspect-interval-flag: - type: "boolean" - description: "This attribute is used to indicate that the performance data\ - \ for the current period may not be reliable. Some reasons for this to\ - \ occur are:\r\n – Suspect data were detected by the\ - \ actual resource doing data collection.\r\n – Transition\ - \ of the administrativeState attribute to/from the 'lock' state.\r\n \ - \ – Transition of the operationalState to/from the 'disabled'\ - \ state.\r\n – Scheduler setting that inhibits the\ - \ collection function.\r\n – The performance counters\ - \ were reset during the interval.\r\n – The currentData\ - \ (or subclass) object instance was created during the monitoring period." - default: false - timestamp: - type: "string" - description: "This attribute indicates the start of the current monitoring\ - \ interval.\r\n The value is bound to the quarter of\ - \ an hour in case of a 15 minute interval and bound to the hour in case\ - \ of a 24 hour interval." - description: "none" - tapi.oam.PmHistoryData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - period-end-time: - type: "string" - description: "none" - suspect-interval-flag: - type: "boolean" - description: "This attribute indicates that the performance data may not\ - \ be reliable." - default: false - description: "none" - tapi.oam.PmThresholdData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - is-transient: - type: "boolean" - description: "none" - default: false - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - description: "none" - tapi.oam.UpdateOamJob: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.updateoamjob.Output" - tapi.oam.UpdateOamService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.updateoamservice.Output" - tapi.oam.UpdateOamServiceEndPoint: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.updateoamserviceendpoint.Output" - tapi.oam.createoamjob.Input: - type: "object" - properties: - schedule: - type: "string" - description: "none" - oam-service-end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - oam-job-type: - type: "string" - description: "none" - oam-profile: - description: "none" - $ref: "#/definitions/tapi.oam.OamProfile" - state: - type: "string" - description: "none" - tapi.oam.createoamjob.Output: - type: "object" - properties: - oam-job: - description: "none" - $ref: "#/definitions/tapi.oam.OamJob" - tapi.oam.createoamservice.Input: - type: "object" - properties: - oam-constraint: - description: "none" - $ref: "#/definitions/tapi.oam.OamConstraint" - state: - type: "string" - description: "none" - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.oam.createoamservice.Output: - type: "object" - properties: - service: - description: "none" - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.createoamserviceendpoint.Input: - type: "object" - properties: - peer-mep-identifier: - type: "array" - description: "none" - items: - type: "string" - service-id: - type: "string" - description: "none" - sip-id: - type: "string" - description: "none" - c-sep-id: - type: "string" - description: "none" - mep-identifier: - type: "string" - description: "none" - state: - type: "string" - description: "none" - layer: - type: "string" - description: "none" - direction: - type: "string" - description: "none" - tapi.oam.createoamserviceendpoint.Output: - type: "object" - properties: - end-point: - description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.oam.deleteoamjob.Input: - type: "object" - properties: - job-id: - type: "string" - description: "none" - tapi.oam.deleteoamservice.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - tapi.oam.deleteoamserviceendpoint.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - o-sep-id: - type: "string" - description: "none" - tapi.oam.getmeg.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - tapi.oam.getmeg.Output: - type: "object" - properties: - meg: - description: "none" - $ref: "#/definitions/tapi.oam.Meg" - tapi.oam.getoamjob.Input: - type: "object" - properties: - job-id: - type: "string" - description: "none" - tapi.oam.getoamjob.Output: - type: "object" - properties: - oam-job: - description: "none" - $ref: "#/definitions/tapi.oam.OamJob" - tapi.oam.getoamservice.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - tapi.oam.getoamservice.Output: - type: "object" - properties: - service: - description: "none" - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.getoamserviceendpoint.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - o-sep-id: - type: "string" - description: "none" - tapi.oam.getoamserviceendpoint.Output: - type: "object" - properties: - end-point: - description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.oam.getoamservicelist.Output: - type: "object" - properties: - service: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.meg.Mep: - allOf: - - $ref: "#/definitions/tapi.oam.Mep" - - $ref: "#/definitions/tapi.odu.MepAugmentation1" - tapi.oam.meg.Mip: - allOf: - - $ref: "#/definitions/tapi.oam.Mip" - - $ref: "#/definitions/tapi.odu.MipAugmentation1" - tapi.oam.oamcontext.Meg: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.common.OperationalStatePac" - - type: "object" - properties: - meg-identifier: - type: "string" - description: "none" - meg-level: - type: "integer" - format: "int32" - description: "none" - mip: - type: "array" - description: "ME may 0, 1, or more MIPs" - items: - $ref: "#/definitions/tapi.oam.meg.Mip" - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - mep: - type: "array" - description: "1. ME may have 0 MEPs (case of transit domains where at least\ - \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case\ - \ of edge domaind, where the peer MEP is ouside the managed domain)\r\n\ - \ 3. ME may have 2 MEPs" - items: - $ref: "#/definitions/tapi.oam.meg.Mep" - direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" - description: "none" - tapi.oam.updateoamjob.Input: - type: "object" - properties: - job-id: - type: "string" - description: "none" - schedule: - type: "string" - description: "none" - oam-profile: - description: "none" - $ref: "#/definitions/tapi.oam.OamProfile" - state: - type: "string" - description: "none" - tapi.oam.updateoamjob.Output: - type: "object" - properties: - oam-job: - description: "none" - $ref: "#/definitions/tapi.oam.OamJob" - tapi.oam.updateoamservice.Input: - type: "object" - properties: - oam-constraint: - description: "none" - $ref: "#/definitions/tapi.oam.OamConstraint" - service-id: - type: "string" - description: "none" - state: - type: "string" - description: "none" - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.oam.updateoamservice.Output: - type: "object" - properties: - service: - description: "none" - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.updateoamserviceendpoint.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - o-sep-id: - type: "string" - description: "none" - state: - type: "string" - description: "none" - tapi.oam.updateoamserviceendpoint.Output: - type: "object" - properties: - end-point: - description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.odu.ConnectionEndPointAugmentation1: - type: "object" - properties: - odu-connection-end-point-spec: - description: "none" - $ref: "#/definitions/tapi.odu.OduConnectionEndPointSpec" - x-augmentation: - prefix: "tapi-odu" - namespace: "urn:onf:otcc:yang:tapi-odu" - tapi.odu.DegThr: - type: "object" - properties: - deg-thr-value: - type: "integer" - format: "int32" - description: "Percentage of detected errored blocks" - percentage-granularity: - description: "none" - $ref: "#/definitions/tapi.odu.PercentageGranularity" - deg-thr-type: - description: "Number of errored blocks" - $ref: "#/definitions/tapi.odu.DegThrType" - tapi.odu.DegThrType: - type: "string" - enum: - - "PERCENTAGE" - - "NUMBER_ERRORED_BLOCKS" - tapi.odu.MappingType: - type: "string" - enum: - - "AMP" - - "BMP" - - "GFP-F" - - "GMP" - - "TTP_GFP_BMP" - - "NULL" - tapi.odu.MepAugmentation1: - type: "object" - properties: - odu-connection-end-point-spec: - description: "none" - $ref: "#/definitions/tapi.odu.OduConnectionEndPointSpec" - x-augmentation: - prefix: "tapi-odu" - namespace: "urn:onf:otcc:yang:tapi-odu" - tapi.odu.MipAugmentation1: - type: "object" - properties: - odu-mip-spec: - description: "none" - $ref: "#/definitions/tapi.odu.OduMipSpec" - x-augmentation: - prefix: "tapi-odu" - namespace: "urn:onf:otcc:yang:tapi-odu" - tapi.odu.OduCommonPac: - type: "object" - properties: - odu-rate-tolerance: - type: "integer" - format: "int32" - description: "This attribute indicates the rate tolerance of the ODU termination\ - \ point. \r\n Valid values are real value in the unit\ - \ of ppm. \r\n Standardized values are defined in Table\ - \ 7-2/G.709." - odu-rate: - type: "integer" - format: "int32" - description: "This attribute indicates the rate of the ODU terminatino point.\ - \ \r\n This attribute is Set at create; i.e., once created\ - \ it cannot be changed directly. \r\n In case of resizable\ - \ ODU flex, its value can be changed via HAO (not directly on the attribute).\ - \ \r\n " - odu-type: - type: "string" - description: "This attribute specifies the type of the ODU termination point." - tapi.odu.OduConnectionEndPointSpec: - type: "object" - properties: - odu-term-and-adapter: - description: "none" - $ref: "#/definitions/tapi.odu.OduTerminationAndClientAdaptationPac" - odu-common: - description: "none" - $ref: "#/definitions/tapi.odu.OduCommonPac" - odu-ctp: - description: "none" - $ref: "#/definitions/tapi.odu.OduCtpPac" - odu-protection: - description: "none" - $ref: "#/definitions/tapi.odu.OduProtectionPac" - tapi.odu.OduCtpPac: - type: "object" - properties: - accepted-msi: - type: "string" - description: "This attribute is applicable when the ODU CTP object instance\ - \ represents a lower order ODU1 or ODU2 CTP Sink at the client layer of\ - \ the ODU3P/ODU12 adaptation function or represents a lower order ODUj CTP\ - \ Sink at the client layer of the ODUP/ODUj-21 adaptation function. This\ - \ attribute is a 1-byte field that represents the accepted multiplex structure\ - \ of the adaptation function. " - tributary-port-number: - type: "integer" - format: "int32" - description: "This attribute identifies the tributary port number that is\ - \ associated with the ODU CTP.\r\n range of type : The\ - \ value range depends on the size of the Tributary Port Number (TPN) field\ - \ used which depends on th server-layer ODU or OTU.\r\n \ - \ In case of ODUk mapping into OTUk, there is no TPN field, so the tributaryPortNumber\ - \ shall be zero.\r\n In case of LO ODUj mapping over\ - \ ODU1, ODU2 or ODU3, the TPN is encoded in a 6-bit field so the value range\ - \ is 0-63. See clause 14.4.1/G.709-2016.\r\n In case\ - \ of LO ODUj mapping over ODU4, the TPN is encoded in a 7-bit field so the\ - \ value range is 0-127. See clause 14.4.1.4/G.709-2016.\r\n \ - \ In case of ODUk mapping over ODUCn, the TPN is encoded in a 14-bit\ - \ field so the value range is 0-16383. See clause 20.4.1.1/G.709-2016.\r\ - \n " - tributary-slot-list: - type: "array" - description: "This attribute contains a set of distinct (i.e. unique) integers\ - \ (e.g. 2, 3, 5, 9, 15 representing the tributary slots TS2, TS3, TS5, TS9\ - \ and TS15) which represents the resources occupied by the Low Order ODU\ - \ Link Connection (e.g. carrying an ODUflex with a bit rate of 6.25G). \r\ - \n This attribute applies when the LO ODU_ ConnectionTerminationPoint\ - \ connects with an HO ODU_TrailTerminationPoint object. \r\n \ - \ It will not apply if this ODU_ ConnectionTerminationPoint object\ - \ directly connects to an OTU_TrailTerminationPoint object (i.e. OTU has\ - \ no trib slots). \r\n The upper bound of the integer\ - \ allowed in this set is a function of the HO-ODU server layer to which\ - \ the ODU connection has been mapped (adapted). \r\n \ - \ Thus, for example, M=8/32/80 for ODU2/ODU3/ODU4 server layers (respectively).\ - \ Note that the value of this attribute can be changed only in the case\ - \ of ODUflex and has to be through specific operations (i.e. not be changing\ - \ the attribute tributarySlotList directly)." - items: - type: "integer" - format: "int32" - tapi.odu.OduDefectPac: - type: "object" - properties: - oci: - type: "boolean" - description: "Open Connection Indicator" - default: false - lck: - type: "boolean" - description: "Locked" - default: false - bdi: - type: "boolean" - description: "Backward Defect Indication" - default: false - ssf: - type: "boolean" - description: "Server Signal Failure" - default: false - deg: - type: "boolean" - description: "Signal Degraded" - default: false - tim: - type: "boolean" - description: "Trail Trace Identifier Mismatch" - default: false - tapi.odu.OduMipPac: - type: "object" - properties: - tim-det-mode: - description: "This attribute indicates the mode of the Trace Identifier Mismatch\ - \ (TIM) Detection function allowed values: OFF, SAPIonly, DAPIonly, SAPIandDAPI" - $ref: "#/definitions/tapi.odu.TimDetMo" - ex-dapi: - type: "string" - description: "The Expected Destination Access Point Identifier (ExDAPI), provisioned\ - \ by the managing system, to be compared with the TTI accepted at the overhead\ - \ position of the sink for the purpose of checking the integrity of connectivity." - deg-m: - type: "integer" - format: "int32" - description: "This attribute indicates the threshold level for declaring a\ - \ Degraded Signal defect (dDEG). A dDEG shall be declared if DegM consecutive\ - \ bad PM Seconds are detected." - acti: - type: "string" - description: "The Trail Trace Identifier (TTI) information recovered (Accepted)\ - \ from the TTI overhead position at the sink of a trail." - ex-sapi: - type: "string" - description: "The Expected Source Access Point Identifier (ExSAPI), provisioned\ - \ by the managing system, to be compared with the TTI accepted at the overhead\ - \ position of the sink for the purpose of checking the integrity of connectivity.\r\ - \n " - deg-thr: - description: "This attribute indicates the threshold level for declaring a\ - \ performance monitoring (PM) Second to be bad. The value of the threshold\ - \ can be provisioned in terms of number of errored blocks or in terms of\ - \ percentage of errored blocks. For percentage-based specification, in order\ - \ to support provision of less than 1%, the specification consists of two\ - \ fields. The first field indicates the granularity of percentage. For examples,\ - \ in 1%, in 0.1%, or in 0.01%, etc. The second field indicates the multiple\ - \ of the granularity. For number of errored block based, the value is a\ - \ positive integer." - $ref: "#/definitions/tapi.odu.DegThr" - tim-act-disabled: - type: "boolean" - description: "This attribute provides the control capability for the managing\ - \ system to enable or disable the Consequent Action function when detecting\ - \ Trace Identifier Mismatch (TIM) at the trail termination sink." - default: true - tapi.odu.OduMipSpec: - type: "object" - properties: - odu-mip: - description: "none" - $ref: "#/definitions/tapi.odu.OduMipPac" - odu-pm: - description: "none" - $ref: "#/definitions/tapi.odu.OduPmPac" - odu-ncm: - description: "none" - $ref: "#/definitions/tapi.odu.OduNcmPac" - odu-tcm: - description: "none" - $ref: "#/definitions/tapi.odu.OduTcmMipPac" - odu-defect: - description: "none" - $ref: "#/definitions/tapi.odu.OduDefectPac" - tapi.odu.OduNamedPayloadType: - type: "string" - enum: - - "UNKNOWN" - - "UNINTERPRETABLE" - tapi.odu.OduNcmPac: - type: "object" - properties: - tcm-fields-in-use: - type: "array" - description: "This attribute indicates the used TCM fields of the ODU OH." - items: - type: "integer" - format: "int32" - tapi.odu.OduNodeEdgePointSpec: - type: "object" - properties: - odu-pool: - description: "none" - $ref: "#/definitions/tapi.odu.OduPoolPac" - tapi.odu.OduPayloadType: - type: "object" - properties: - hex-payload-type: - type: "integer" - format: "int32" - description: "none" - named-payload-type: - description: "none" - $ref: "#/definitions/tapi.odu.OduNamedPayloadType" - tapi.odu.OduPmPac: - type: "object" - properties: - f-ses: - type: "integer" - format: "int32" - description: "Far-end Severely Errored Second" - n-bbe: - type: "integer" - format: "int32" - description: "Near-end Background Block Error" - f-bbe: - type: "integer" - format: "int32" - description: "Far-end Background Block Error" - uas: - description: "UnAvailable Second" - $ref: "#/definitions/tapi.odu.UasChoice" - n-ses: - type: "integer" - format: "int32" - description: "Near-end Severely Errored Second" - tapi.odu.OduPoolPac: - type: "object" - properties: - client-capacity: - type: "integer" - format: "int32" - description: "none" - max-client-size: - type: "integer" - format: "int32" - description: "none" - max-client-instances: - type: "integer" - format: "int32" - description: "none" - tapi.odu.OduProtectionPac: - type: "object" - properties: - aps-enable: - type: "boolean" - description: "This attribute is for enabling/disabling the automatic protection\ - \ switching (APS) capability at the transport adaptation function that is\ - \ represented by the ODU_ConnectionTerminationPoint object class. It triggers\ - \ the MI_APS_EN signal to the transport adaptation function." - default: true - aps-level: - type: "integer" - format: "int32" - description: "This attribute is for configuring the automatic protection switching\ - \ (APS) level that should operate at the transport adaptation function that\ - \ is represented by the ODU_ConnectionTerminationPoint object class. It\ - \ triggers the MI_APS_LVL signal to the transport adaptation function. The\ - \ value 0 means path and the values 1 through 6 mean TCM level 1 through\ - \ 6 respectively." - tapi.odu.OduSlotSize: - type: "string" - enum: - - "1G25" - - "2G5" - tapi.odu.OduTcmMipPac: - type: "object" - properties: - tcm-field: - type: "integer" - format: "int32" - description: "This attribute indicates the tandem connection monitoring field\ - \ of the ODU OH." - tapi.odu.OduTerminationAndClientAdaptationPac: - type: "object" - properties: - configured-mapping-type: - description: "This attributes indicates the configured mapping type." - $ref: "#/definitions/tapi.odu.MappingType" - auto-payload-type: - type: "boolean" - description: "This attribute is applicable when the ODU CTP object instance\ - \ represents a lower order ODU CTP Source at the client layer of the ODUP/ODUj-21\ - \ adaptation function. The value of true of this attribute configures that\ - \ the adaptation source function shall fall back to the payload type PT=20\ - \ if the conditions specified in 14.3.10.1/G.798 are satisfied. " - default: false - accepted-payload-type: - description: "This attribute is applicable when the ODU CTP object instance\ - \ represents a lower order ODU CTP Sink at the client layer of the ODUP/ODU[i]j\ - \ or ODUP/ODUj-21 adaptation function. \r\n This attribute\ - \ is a 2-digit Hex code that indicates the new accepted payload type.\r\n\ - \ Valid values are defined in Table 15-8 of ITU-T Recommendation\ - \ G.709 with one additional value UN_INTERPRETABLE." - $ref: "#/definitions/tapi.odu.OduPayloadType" - opu-tributary-slot-size: - description: "This attribute is applicable for ODU2 and ODU3 CTP only. It\ - \ indicates the slot size of the ODU CTP." - $ref: "#/definitions/tapi.odu.OduSlotSize" - configured-client-type: - type: "string" - description: "This attribute configures the type of the client CTP of the\ - \ server ODU TTP." - tapi.odu.OwnedNodeEdgePointAugmentation2: - type: "object" - properties: - odu-node-edge-point-spec: - description: "Augments the base LayerProtocol information in NodeEdgePoint\ - \ with ODU-specific information" - $ref: "#/definitions/tapi.odu.OduNodeEdgePointSpec" - x-augmentation: - prefix: "tapi-odu" - namespace: "urn:onf:otcc:yang:tapi-odu" - tapi.odu.PercentageGranularity: - type: "string" - enum: - - "ONES" - - "ONE_TENTHS" - - "ONE_HUNDREDTHS" - - "ONE_THOUSANDTHS" - tapi.odu.TimDetMo: - type: "string" - enum: - - "DAPI" - - "SAPI" - - "BOTH" - - "OFF" - tapi.odu.UasChoice: - type: "object" - properties: - fuas: - type: "integer" - format: "int32" - description: "none" - bidirectional: - type: "boolean" - description: "none" - default: true - nuas: - type: "integer" - format: "int32" - description: "none" - uas: - type: "integer" - format: "int32" - description: "none" - tapi.path.computation.ComputeP2PPath: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.path.computation.computep2ppath.Output" - tapi.path.computation.ContextAugmentation3: - 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.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.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.PathOptimizationConstraint: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - traffic-interruption: - description: "none" - $ref: "#/definitions/tapi.common.DirectiveValue" - description: "none" - 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.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.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 - 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" - 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.TopologyConstraint: - type: "object" - properties: - include-node: - type: "array" - description: "This is a loose constraint - that is it is unordered and could\ - \ be a partial list" - items: - $ref: "#/definitions/tapi.topology.NodeRef" - exclude-link: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.LinkRef" - avoid-topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - exclude-path: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.path.computation.PathRef" - include-link: - type: "array" - description: "This is a loose constraint - that is it is unordered and could\ - \ be a partial list " - items: - $ref: "#/definitions/tapi.topology.LinkRef" - preferred-transport-layer: - type: "array" - description: "soft constraint requested by client to indicate the layer(s)\ - \ of transport connection that it prefers to carry the service. This could\ - \ be same as the service layer or one of the supported server layers" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - exclude-node: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRef" - include-topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - include-path: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.path.computation.PathRef" - 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.ContextAugmentation5: - type: "object" - properties: - topology-context: - description: "Augments the base TAPI Context with TopologyService information" - $ref: "#/definitions/tapi.topology.TopologyContext" - x-augmentation: - prefix: "tapi-topology" - namespace: "urn:onf:otcc:yang:tapi-topology" - tapi.topology.CostCharacteristic: - type: "object" - properties: - cost-value: - type: "string" - description: "The specific cost." - cost-algorithm: - type: "string" - description: "The cost may vary based upon some properties of the TopologicalEntity.\ - \ The rules for the variation are conveyed by the costAlgorithm." - cost-name: - type: "string" - description: "The cost characteristic will related to some aspect of the TopologicalEntity\ - \ (e.g. $ cost, routing weight). This aspect will be conveyed by the costName." - tapi.topology.ForwardingRule: - type: "string" - enum: - - "MAY_FORWARD_ACROSS_GROUP" - - "MUST_FORWARD_ACROSS_GROUP" - - "CANNOT_FORWARD_ACROSS_GROUP" - - "NO_STATEMENT_ON_FORWARDING" - tapi.topology.GetLinkDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.getlinkdetails.Output" - tapi.topology.GetNodeDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.getnodedetails.Output" - tapi.topology.GetNodeEdgePointDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Output" - tapi.topology.GetTopologyDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.gettopologydetails.Output" - tapi.topology.GetTopologyList: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.gettopologylist.Output" - tapi.topology.InterRuleGroup: - allOf: - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.RiskParameterPac" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - type: "object" - properties: - associated-node-rule-group: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - rule: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Rule" - description: "none" - tapi.topology.LatencyCharacteristic: - type: "object" - properties: - traffic-property-name: - type: "string" - description: "The identifier of the specific traffic property to which the\ - \ queuing latency applies." - jitter-characteristic: - type: "string" - description: "High frequency deviation from true periodicity of a signal and\ - \ therefore a small high rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." - fixed-latency-characteristic: - type: "string" - description: "A TopologicalEntity suffers delay caused by the realization\ - \ of the servers (e.g. distance related; FEC encoding etc.) along with some\ - \ client specific processing. This is the total average latency effect of\ - \ the TopologicalEntity" - wander-characteristic: - type: "string" - description: "Low frequency deviation from true periodicity of a signal and\ - \ therefore a small low rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." - queing-latency-characteristic: - type: "string" - description: "The specific queuing latency for the traffic property." - tapi.topology.LayerProtocolTransitionPac: - type: "object" - properties: - transitioned-layer-protocol-name: - type: "array" - description: "Provides the ordered structure of layer protocol transitions\ - \ encapsulated in the TopologicalEntity. The ordering relates to the LinkPort\ - \ role." - items: - type: "string" - tapi.topology.Link: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.LayerProtocolTransitionPac" - - $ref: "#/definitions/tapi.topology.RiskParameterPac" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - $ref: "#/definitions/tapi.topology.ValidationPac" - - type: "object" - properties: - layer-protocol-name: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - 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.NetworkTopologyService: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - description: "none" - tapi.topology.Node: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - type: "object" - properties: - layer-protocol-name: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - encap-topology: - description: "none" - $ref: "#/definitions/tapi.topology.TopologyRef" - 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.NodeRef: - allOf: - - $ref: "#/definitions/tapi.topology.TopologyRef" - - type: "object" - properties: - node-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:uuid" - description: "none" - tapi.topology.NodeRuleGroup: - allOf: - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.RiskParameterPac" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - type: "object" - properties: - inter-rule-group: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.InterRuleGroup" - rule: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Rule" - composed-rule-group: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - node-edge-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - description: "none" - tapi.topology.NodeRuleGroupRef: - allOf: - - $ref: "#/definitions/tapi.topology.NodeRef" - - type: "object" - properties: - node-rule-group-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-rule-group/tapi-topology:uuid" - description: "none" - tapi.topology.ProtectionType: - type: "string" - enum: - - "NO_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" - 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.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.RiskParameterPac: - type: "object" - properties: - risk-characteristic: - type: "array" - description: "A list of risk characteristics for consideration in an analysis\ - \ of shared risk. Each element of the list represents a specific risk consideration." - items: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - tapi.topology.Rule: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - override-priority: - type: "integer" - format: "int32" - description: "none" - forwarding-rule: - description: "none" - $ref: "#/definitions/tapi.topology.ForwardingRule" - rule-type: - description: "none" - $ref: "#/definitions/tapi.topology.RuleType" - description: "none" - tapi.topology.RuleType: - type: "string" - enum: - - "FORWARDING" - - "CAPACITY" - - "COST" - - "TIMING" - - "RISK" - - "GROUPING" - tapi.topology.Topology: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - layer-protocol-name: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - link: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Link" - node: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Node" - description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ - \ topological component which is used to effect forwarding of transport characteristic\ - \ information and offers the potential to enable forwarding. \r\n \ - \ At the lowest level of recursion, an FD (within a network element\ - \ (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ - \ multiple switch matrices (FDs). " - tapi.topology.TopologyContext: - type: "object" - properties: - nw-topology-service: - description: "none" - $ref: "#/definitions/tapi.topology.NetworkTopologyService" - topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Topology" - tapi.topology.TopologyRef: - type: "object" - properties: - topology-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:uuid" - tapi.topology.TransferCostPac: - type: "object" - properties: - cost-characteristic: - type: "array" - description: "The list of costs where each cost relates to some aspect of\ - \ the TopologicalEntity." - items: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - tapi.topology.TransferIntegrityPac: - type: "object" - properties: - error-characteristic: - type: "string" - description: "Describes the degree to which the signal propagated can be errored.\ - \ \r\n Applies to TDM systems as the errored signal will\ - \ be propagated and not packet as errored packets will be discarded." - unavailable-time-characteristic: - type: "string" - description: "Describes the duration for which there may be no valid signal\ - \ propagated." - server-integrity-process-characteristic: - type: "string" - description: "Describes the effect of any server integrity enhancement process\ - \ on the characteristics of the TopologicalEntity." - delivery-order-characteristic: - type: "string" - description: "Describes the degree to which packets will be delivered out\ - \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ - \ maintain strict order." - repeat-delivery-characteristic: - type: "string" - description: "Primarily applies to packet systems where a packet may be delivered\ - \ more than once (in fault recovery for example). \r\n \ - \ It can also apply to TDM where several frames may be received twice\ - \ due to switching in a system with a large differential propagation delay." - loss-characteristic: - type: "string" - description: "Describes the acceptable characteristic of lost packets where\ - \ loss may result from discard due to errors or overflow.\r\n \ - \ Applies to packet systems and not TDM (as for TDM errored signals\ - \ are propagated unless grossly errored and overflow/underflow turns into\ - \ timing slips)." - tapi.topology.TransferTimingPac: - type: "object" - properties: - latency-characteristic: - type: "array" - description: "The effect on the latency of a queuing process. This only has\ - \ significant effect for packet based systems and has a complex characteristic." - items: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - tapi.topology.ValidationMechanism: - type: "object" - properties: - layer-protocol-adjacency-validated: - type: "string" - description: "State of validatiion" - validation-mechanism: - type: "string" - description: "Name of mechanism used to validate adjacency" - validation-robustness: - type: "string" - description: "Quality of validation (i.e. how likely is the stated validation\ - \ to be invalid)" - tapi.topology.ValidationPac: - type: "object" - properties: - validation-mechanism: - type: "array" - description: "Provides details of the specific validation mechanism(s) used\ - \ to confirm the presence of an intended topologicalEntity." - items: - $ref: "#/definitions/tapi.topology.ValidationMechanism" - tapi.topology.getlinkdetails.Input: - type: "object" - properties: - link-id-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.odu.OwnedNodeEdgePointAugmentation2" - - $ref: "#/definitions/tapi.topology.NodeEdgePoint" - tapi.topology.topology.Node: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.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" diff --git a/OAS/tapi-path-computation@2018-12-10.yaml b/OAS/tapi-path-computation@2018-12-10.yaml deleted file mode 100644 index 975aa5e7..00000000 --- a/OAS/tapi-path-computation@2018-12-10.yaml +++ /dev/null @@ -1,9391 +0,0 @@ ---- -swagger: "2.0" -info: - description: "tapi-path-computation,tapi-notification,tapi-topology,tapi-common\ - \ API generated from yang definitions" - version: "1.0" - title: "tapi-path-computation,tapi-notification,tapi-topology,tapi-common API" -host: "localhost:1234" -consumes: -- "application/yang-data+json" -produces: -- "application/yang-data+json" -paths: - /data/context/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Context" - parameters: [] - responses: - 200: - description: "tapi.common.Context" - schema: - $ref: "#/definitions/tapi.common.Context" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.Context" - parameters: - - in: "body" - name: "tapi.common.Context.body-param" - description: "tapi.common.Context to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.Context" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.Context" - parameters: - - in: "body" - name: "tapi.common.Context.body-param" - description: "tapi.common.Context to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.Context" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.Context" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationContext" - parameters: [] - responses: - 200: - description: "tapi.notification.NotificationContext" - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationContext" - parameters: - - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationContext" - parameters: - - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription/: - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" - parameters: - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NotificationSubscriptionService" - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NotificationChannel" - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.Notification" - schema: - $ref: "#/definitions/tapi.notification.Notification" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of additional-info" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of changed-attributes" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NameAndValueChange" - schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of target-object-name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/tca-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.SubscriptionFilter" - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notification={uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.Notification" - schema: - $ref: "#/definitions/tapi.notification.Notification" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/additional-info={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of additional-info" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of changed-attributes" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NameAndValueChange" - schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of target-object-name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/tca-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" - /data/context/path-computation-context/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathComputationContext" - parameters: [] - responses: - 200: - description: "tapi.path.computation.PathComputationContext" - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationContext" - parameters: - - in: "body" - name: "tapi.path.computation.PathComputationContext.body-param" - description: "tapi.path.computation.PathComputationContext to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathComputationContext" - parameters: - - in: "body" - name: "tapi.path.computation.PathComputationContext.body-param" - description: "tapi.path.computation.PathComputationContext to be added or\ - \ updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathComputationContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationService" - parameters: - - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathComputationService" - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - 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.PathComputationService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - 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.PathServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathServiceEndPoint" - schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.Capacity" - 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.Capacity" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.Capacity" - 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.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.Capacity" - 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.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.BandwidthProfile" - 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.BandwidthProfile" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/total-size/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/service-interface-point/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathObjectiveFunction" - schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathObjectiveFunction.body-param" - description: "tapi.path.computation.PathObjectiveFunction to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathObjectiveFunction.body-param" - description: "tapi.path.computation.PathObjectiveFunction to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathOptimizationConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathOptimizationConstraint.body-param" - description: "tapi.path.computation.PathOptimizationConstraint to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathOptimizationConstraint.body-param" - description: "tapi.path.computation.PathOptimizationConstraint to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.RoutingConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.RoutingConstraint.body-param" - description: "tapi.path.computation.RoutingConstraint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.RoutingConstraint.body-param" - description: "tapi.path.computation.RoutingConstraint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.TopologyConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.TopologyConstraint.body-param" - description: "tapi.path.computation.TopologyConstraint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.TopologyConstraint.body-param" - description: "tapi.path.computation.TopologyConstraint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/avoid-topology={topology-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of avoid-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of exclude-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of include-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-topology={topology-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.Path" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.Path" - schema: - $ref: "#/definitions/tapi.path.computation.Path" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.RoutingConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/service-interface-point/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePoint" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/available-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/total-potential-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyContext" - parameters: [] - responses: - 200: - description: "tapi.topology.TopologyContext" - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-topology" - description: "creates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-topology" - description: "creates or updates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-topology" - description: "removes tapi.topology.TopologyContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/topology-context/nw-topology-service/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NetworkTopologyService" - parameters: [] - responses: - 200: - description: "tapi.topology.NetworkTopologyService" - schema: - $ref: "#/definitions/tapi.topology.NetworkTopologyService" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "topology-uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Topology" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Topology" - schema: - $ref: "#/definitions/tapi.topology.Topology" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Link" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Link" - schema: - $ref: "#/definitions/tapi.topology.Link" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/resilience-type/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ValidationMechanism" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "validation-mechanism" - in: "path" - description: "Id of validation-mechanism" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ValidationMechanism" - schema: - $ref: "#/definitions/tapi.topology.ValidationMechanism" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Node" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Node" - schema: - $ref: "#/definitions/tapi.topology.Node" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroup" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroup" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-rule-group-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroupRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.InterRuleGroup" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.InterRuleGroup" - schema: - $ref: "#/definitions/tapi.topology.InterRuleGroup" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-rule-group-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroupRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Rule" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Rule" - schema: - $ref: "#/definitions/tapi.topology.Rule" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Rule" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Rule" - schema: - $ref: "#/definitions/tapi.topology.Rule" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePoint" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePoint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "service-interface-point-uuid" - in: "path" - description: "Id of mapped-service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /operations/compute-p-2-p-path/: - post: - tags: - - "tapi-path-computation" - parameters: - - in: "body" - name: "tapi.path.computation.computep2ppath.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.path.computation.computep2ppath.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.path.computation.ComputeP2PPath" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-notification-subscription-service/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.CreateNotificationSubscriptionService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/delete-notification-subscription-service/: - post: - tags: - - "tapi-notification" - 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/delete-p-2-p-path/: - post: - tags: - - "tapi-path-computation" - 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/get-link-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.getlinkdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.getlinkdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetLinkDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-node-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.getnodedetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.getnodedetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetNodeDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-node-edge-point-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.getnodeedgepointdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetNodeEdgePointDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-list/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.getnotificationlist.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.getnotificationlist.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-subscription-service-details/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-subscription-service-list/: - post: - tags: - - "tapi-notification" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-service-interface-point-details/: - post: - tags: - - "tapi-common" - parameters: - - in: "body" - name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.common.GetServiceInterfacePointDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-service-interface-point-list/: - post: - tags: - - "tapi-common" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.common.GetServiceInterfacePointList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-supported-notification-types/: - post: - tags: - - "tapi-notification" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetSupportedNotificationTypes" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-topology-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.gettopologydetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.gettopologydetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetTopologyDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-topology-list/: - post: - tags: - - "tapi-topology" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetTopologyList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/optimize-p-2-p-path/: - post: - tags: - - "tapi-path-computation" - 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/update-notification-subscription-service/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.UpdateNotificationSubscriptionService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-service-interface-point/: - post: - tags: - - "tapi-common" - parameters: - - in: "body" - name: "tapi.common.updateserviceinterfacepoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.common.updateserviceinterfacepoint.Input" - responses: - 201: - description: "No response" - 400: - description: "Internal error" -definitions: - tapi.common.AdminStatePac: - type: "object" - properties: - operational-state: - description: "none" - $ref: "#/definitions/tapi.common.OperationalState" - lifecycle-state: - description: "none" - $ref: "#/definitions/tapi.common.LifecycleState" - administrative-state: - description: "none" - $ref: "#/definitions/tapi.common.AdministrativeState" - tapi.common.AdministrativeState: - type: "string" - enum: - - "LOCKED" - - "UNLOCKED" - tapi.common.BandwidthProfile: - type: "object" - properties: - committed-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - coupling-flag: - type: "boolean" - description: "none" - default: false - bw-profile-type: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfileType" - peak-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - committed-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - peak-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - color-aware: - type: "boolean" - description: "none" - default: false - tapi.common.BandwidthProfileType: - type: "string" - enum: - - "MEF_10.x" - - "RFC_2697" - - "RFC_2698" - - "RFC_4115" - tapi.common.Capacity: - type: "object" - properties: - bandwidth-profile: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfile" - total-size: - description: "Total capacity of the TopologicalEntity in MB/s. In case of\ - \ bandwidthProfile, this is expected to same as the committedInformationRate." - $ref: "#/definitions/tapi.common.CapacityValue" - tapi.common.CapacityPac: - type: "object" - properties: - available-capacity: - description: "Capacity available to be assigned." - $ref: "#/definitions/tapi.common.Capacity" - total-potential-capacity: - description: "An optimistic view of the capacity of the TopologicalEntity\ - \ assuming that any shared capacity is available to be taken." - $ref: "#/definitions/tapi.common.Capacity" - tapi.common.CapacityUnit: - type: "string" - enum: - - "TB" - - "TBPS" - - "GB" - - "GBPS" - - "MB" - - "MBPS" - - "KB" - - "KBPS" - - "GHz" - - "MHz" - tapi.common.CapacityValue: - type: "object" - properties: - value: - type: "integer" - format: "int32" - description: "none" - unit: - description: "none" - $ref: "#/definitions/tapi.common.CapacityUnit" - tapi.common.Context: - allOf: - - $ref: "#/definitions/tapi.common.TapiContext" - - $ref: "#/definitions/tapi.notification.ContextAugmentation1" - - $ref: "#/definitions/tapi.path.computation.ContextAugmentation2" - - $ref: "#/definitions/tapi.topology.ContextAugmentation3" - 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.OperationalState: - type: "string" - enum: - - "DISABLED" - - "ENABLED" - tapi.common.PortDirection: - type: "string" - enum: - - "BIDIRECTIONAL" - - "INPUT" - - "OUTPUT" - - "UNIDENTIFIED_OR_UNKNOWN" - tapi.common.PortRole: - type: "string" - enum: - - "SYMMETRIC" - - "ROOT" - - "LEAF" - - "TRUNK" - - "UNKNOWN" - tapi.common.ServiceInterfacePoint: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - supported-layer-protocol-qualifier: - type: "array" - description: "none" - items: - type: "string" - layer-protocol-name: - description: "Usage of layerProtocolName [>1] in the ServiceInterfacePoint\ - \ should be considered experimental" - $ref: "#/definitions/tapi.common.LayerProtocolName" - description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ - \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ - \ circuit and packet forms." - tapi.common.ServiceInterfacePointRef: - type: "object" - properties: - service-interface-point-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-common:service-interface-point/tapi-common:uuid" - tapi.common.TapiContext: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - service-interface-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - description: "The Network Control Domain (NCD) object class represents the scope\ - \ of control that a particular SDN controller has with respect to a particular\ - \ network, (i.e., encompassing a designated set of interconnected (virtual)\ - \ network elements)." - tapi.common.TerminationDirection: - type: "string" - enum: - - "BIDIRECTIONAL" - - "SINK" - - "SOURCE" - - "UNDEFINED_OR_UNKNOWN" - tapi.common.TerminationPac: - type: "object" - properties: - termination-direction: - description: "The overall directionality of the LP. \r\n \ - \ - A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ - \ - A SINK LP can only contain elements with SINK flows\ - \ or CONTRA_DIRECTION_SOURCE flows\r\n - A SOURCE LP\ - \ can only contain SOURCE flows or CONTRA_DIRECTION_SINK flows" - $ref: "#/definitions/tapi.common.TerminationDirection" - termination-state: - description: "Indicates whether the layer is terminated and if so how." - $ref: "#/definitions/tapi.common.TerminationState" - tapi.common.TerminationState: - type: "string" - enum: - - "LP_CAN_NEVER_TERMINATE" - - "LT_NOT_TERMINATED" - - "TERMINATED_SERVER_TO_CLIENT_FLOW" - - "TERMINATED_CLIENT_TO_SERVER_FLOW" - - "TERMINATED_BIDIRECTIONAL" - - "LT_PERMENANTLY_TERMINATED" - - "TERMINATION_STATE_UNKNOWN" - tapi.common.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.notification.AlarmInfo: - type: "object" - properties: - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedSeverityType" - probable-cause: - type: "string" - description: "none" - service-affecting: - description: "none" - $ref: "#/definitions/tapi.notification.ServiceAffecting" - is-transient: - type: "boolean" - description: "none" - default: false - tapi.notification.ContextAugmentation1: - type: "object" - properties: - notification-context: - description: "Augments the base TAPI Context with NotificationService information" - $ref: "#/definitions/tapi.notification.NotificationContext" - 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.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.NotificationContext: - type: "object" - properties: - notif-subscription: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - notification: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.Notification" - tapi.notification.NotificationSubscriptionService: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - notification: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.Notification" - notification-channel: - description: "none" - $ref: "#/definitions/tapi.notification.NotificationChannel" - subscription-state: - description: "none" - $ref: "#/definitions/tapi.notification.SubscriptionState" - supported-object-types: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.ObjectType" - supported-notification-types: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.NotificationType" - subscription-filter: - description: "none" - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - description: "none" - tapi.notification.NotificationType: - type: "string" - enum: - - "OBJECT_CREATION" - - "OBJECT_DELETION" - - "ATTRIBUTE_VALUE_CHANGE" - - "ALARM_EVENT" - - "THRESHOLD_CROSSING_ALERT" - tapi.notification.ObjectType: - type: "string" - enum: - - "TOPOLOGY" - - "NODE" - - "LINK" - - "CONNECTION" - - "PATH" - - "CONNECTIVITY_SERVICE" - - "VIRTUAL_NETWORK_SERVICE" - - "PATH_COMPUTATION_SERVICE" - - "NODE_EDGE_POINT" - - "SERVICE_INTERFACE_POINT" - - "CONNECTION_END_POINT" - - "MAINTENANCE_ENTITY_GROUP" - - "MAINTENANCE_ENTITY" - - "MEG_END_POINT" - - "MEG_INTERMEDIATE_POINT" - - "SWITCH_CONTROL" - - "SWITCH" - - "ROUTE" - - "NODE_RULE_GROUP" - - "INTER_RULE_GROUP" - - "RULE" - - "OAM_JOB" - tapi.notification.PerceivedSeverityType: - type: "string" - enum: - - "CRITICAL" - - "MAJOR" - - "MINOR" - - "WARNING" - - "CLEARED" - tapi.notification.PerceivedTcaSeverity: - type: "string" - enum: - - "WARNING" - - "CLEAR" - tapi.notification.ServiceAffecting: - type: "string" - enum: - - "SERVICE_AFFECTING" - - "NOT_SERVICE_AFFECTING" - - "UNKNOWN" - 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.SubscriptionState: - type: "string" - enum: - - "SUSPENDED" - - "ACTIVE" - tapi.notification.TcaInfo: - type: "object" - properties: - threshold-crossing: - description: "none" - $ref: "#/definitions/tapi.notification.ThresholdCrossingType" - threshold-parameter: - type: "string" - description: "none" - is-transient: - type: "boolean" - description: "none" - default: false - threshold-value: - type: "integer" - format: "int32" - description: "none" - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedTcaSeverity" - suspect-interval-flag: - type: "boolean" - description: "none" - default: false - measurement-interval: - type: "string" - description: "none" - tapi.notification.ThresholdCrossingType: - type: "string" - enum: - - "THRESHOLD_ABOVE" - - "THRESHOLD_BELOW" - - "CLEARED" - tapi.notification.UpdateNotificationSubscriptionService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Output" - tapi.notification.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.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.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.PathOptimizationConstraint: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - traffic-interruption: - description: "none" - $ref: "#/definitions/tapi.common.DirectiveValue" - description: "none" - 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.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.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 - 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" - 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.TopologyConstraint: - type: "object" - properties: - include-node: - type: "array" - description: "This is a loose constraint - that is it is unordered and could\ - \ be a partial list" - items: - $ref: "#/definitions/tapi.topology.NodeRef" - exclude-link: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.LinkRef" - avoid-topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - exclude-path: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.path.computation.PathRef" - include-link: - type: "array" - description: "This is a loose constraint - that is it is unordered and could\ - \ be a partial list " - items: - $ref: "#/definitions/tapi.topology.LinkRef" - preferred-transport-layer: - type: "array" - description: "soft constraint requested by client to indicate the layer(s)\ - \ of transport connection that it prefers to carry the service. This could\ - \ be same as the service layer or one of the supported server layers" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - exclude-node: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRef" - include-topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - include-path: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.path.computation.PathRef" - 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.ContextAugmentation3: - type: "object" - properties: - topology-context: - description: "Augments the base TAPI Context with TopologyService information" - $ref: "#/definitions/tapi.topology.TopologyContext" - x-augmentation: - prefix: "tapi-topology" - namespace: "urn:onf:otcc:yang:tapi-topology" - tapi.topology.CostCharacteristic: - type: "object" - properties: - cost-value: - type: "string" - description: "The specific cost." - cost-algorithm: - type: "string" - description: "The cost may vary based upon some properties of the TopologicalEntity.\ - \ The rules for the variation are conveyed by the costAlgorithm." - cost-name: - type: "string" - description: "The cost characteristic will related to some aspect of the TopologicalEntity\ - \ (e.g. $ cost, routing weight). This aspect will be conveyed by the costName." - tapi.topology.ForwardingRule: - type: "string" - enum: - - "MAY_FORWARD_ACROSS_GROUP" - - "MUST_FORWARD_ACROSS_GROUP" - - "CANNOT_FORWARD_ACROSS_GROUP" - - "NO_STATEMENT_ON_FORWARDING" - tapi.topology.GetLinkDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.getlinkdetails.Output" - tapi.topology.GetNodeDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.getnodedetails.Output" - tapi.topology.GetNodeEdgePointDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Output" - tapi.topology.GetTopologyDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.gettopologydetails.Output" - tapi.topology.GetTopologyList: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.gettopologylist.Output" - tapi.topology.InterRuleGroup: - allOf: - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.RiskParameterPac" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - type: "object" - properties: - associated-node-rule-group: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - rule: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Rule" - description: "none" - tapi.topology.LatencyCharacteristic: - type: "object" - properties: - traffic-property-name: - type: "string" - description: "The identifier of the specific traffic property to which the\ - \ queuing latency applies." - jitter-characteristic: - type: "string" - description: "High frequency deviation from true periodicity of a signal and\ - \ therefore a small high rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." - fixed-latency-characteristic: - type: "string" - description: "A TopologicalEntity suffers delay caused by the realization\ - \ of the servers (e.g. distance related; FEC encoding etc.) along with some\ - \ client specific processing. This is the total average latency effect of\ - \ the TopologicalEntity" - wander-characteristic: - type: "string" - description: "Low frequency deviation from true periodicity of a signal and\ - \ therefore a small low rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." - queing-latency-characteristic: - type: "string" - description: "The specific queuing latency for the traffic property." - tapi.topology.LayerProtocolTransitionPac: - type: "object" - properties: - transitioned-layer-protocol-name: - type: "array" - description: "Provides the ordered structure of layer protocol transitions\ - \ encapsulated in the TopologicalEntity. The ordering relates to the LinkPort\ - \ role." - items: - type: "string" - tapi.topology.Link: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.LayerProtocolTransitionPac" - - $ref: "#/definitions/tapi.topology.RiskParameterPac" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - $ref: "#/definitions/tapi.topology.ValidationPac" - - type: "object" - properties: - layer-protocol-name: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - 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.NetworkTopologyService: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - description: "none" - tapi.topology.Node: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - type: "object" - properties: - layer-protocol-name: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - encap-topology: - description: "none" - $ref: "#/definitions/tapi.topology.TopologyRef" - 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.NodeRef: - allOf: - - $ref: "#/definitions/tapi.topology.TopologyRef" - - type: "object" - properties: - node-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:uuid" - description: "none" - tapi.topology.NodeRuleGroup: - allOf: - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.RiskParameterPac" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - type: "object" - properties: - inter-rule-group: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.InterRuleGroup" - rule: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Rule" - composed-rule-group: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - node-edge-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - description: "none" - tapi.topology.NodeRuleGroupRef: - allOf: - - $ref: "#/definitions/tapi.topology.NodeRef" - - type: "object" - properties: - node-rule-group-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-rule-group/tapi-topology:uuid" - description: "none" - tapi.topology.ProtectionType: - type: "string" - enum: - - "NO_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" - 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.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.RiskParameterPac: - type: "object" - properties: - risk-characteristic: - type: "array" - description: "A list of risk characteristics for consideration in an analysis\ - \ of shared risk. Each element of the list represents a specific risk consideration." - items: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - tapi.topology.Rule: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - override-priority: - type: "integer" - format: "int32" - description: "none" - forwarding-rule: - description: "none" - $ref: "#/definitions/tapi.topology.ForwardingRule" - rule-type: - description: "none" - $ref: "#/definitions/tapi.topology.RuleType" - description: "none" - tapi.topology.RuleType: - type: "string" - enum: - - "FORWARDING" - - "CAPACITY" - - "COST" - - "TIMING" - - "RISK" - - "GROUPING" - tapi.topology.Topology: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - layer-protocol-name: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - link: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Link" - node: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Node" - description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ - \ topological component which is used to effect forwarding of transport characteristic\ - \ information and offers the potential to enable forwarding. \r\n \ - \ At the lowest level of recursion, an FD (within a network element\ - \ (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ - \ multiple switch matrices (FDs). " - tapi.topology.TopologyContext: - type: "object" - properties: - nw-topology-service: - description: "none" - $ref: "#/definitions/tapi.topology.NetworkTopologyService" - topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Topology" - tapi.topology.TopologyRef: - type: "object" - properties: - topology-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:uuid" - tapi.topology.TransferCostPac: - type: "object" - properties: - cost-characteristic: - type: "array" - description: "The list of costs where each cost relates to some aspect of\ - \ the TopologicalEntity." - items: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - tapi.topology.TransferIntegrityPac: - type: "object" - properties: - error-characteristic: - type: "string" - description: "Describes the degree to which the signal propagated can be errored.\ - \ \r\n Applies to TDM systems as the errored signal will\ - \ be propagated and not packet as errored packets will be discarded." - unavailable-time-characteristic: - type: "string" - description: "Describes the duration for which there may be no valid signal\ - \ propagated." - server-integrity-process-characteristic: - type: "string" - description: "Describes the effect of any server integrity enhancement process\ - \ on the characteristics of the TopologicalEntity." - delivery-order-characteristic: - type: "string" - description: "Describes the degree to which packets will be delivered out\ - \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ - \ maintain strict order." - repeat-delivery-characteristic: - type: "string" - description: "Primarily applies to packet systems where a packet may be delivered\ - \ more than once (in fault recovery for example). \r\n \ - \ It can also apply to TDM where several frames may be received twice\ - \ due to switching in a system with a large differential propagation delay." - loss-characteristic: - type: "string" - description: "Describes the acceptable characteristic of lost packets where\ - \ loss may result from discard due to errors or overflow.\r\n \ - \ Applies to packet systems and not TDM (as for TDM errored signals\ - \ are propagated unless grossly errored and overflow/underflow turns into\ - \ timing slips)." - tapi.topology.TransferTimingPac: - type: "object" - properties: - latency-characteristic: - type: "array" - description: "The effect on the latency of a queuing process. This only has\ - \ significant effect for packet based systems and has a complex characteristic." - items: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - tapi.topology.ValidationMechanism: - type: "object" - properties: - layer-protocol-adjacency-validated: - type: "string" - description: "State of validatiion" - validation-mechanism: - type: "string" - description: "Name of mechanism used to validate adjacency" - validation-robustness: - type: "string" - description: "Quality of validation (i.e. how likely is the stated validation\ - \ to be invalid)" - tapi.topology.ValidationPac: - type: "object" - properties: - validation-mechanism: - type: "array" - description: "Provides details of the specific validation mechanism(s) used\ - \ to confirm the presence of an intended topologicalEntity." - items: - $ref: "#/definitions/tapi.topology.ValidationMechanism" - tapi.topology.getlinkdetails.Input: - type: "object" - properties: - link-id-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" diff --git a/OAS/tapi-photonic-media@2018-12-10.yaml b/OAS/tapi-photonic-media@2018-12-10.yaml deleted file mode 100644 index 723d9bc4..00000000 --- a/OAS/tapi-photonic-media@2018-12-10.yaml +++ /dev/null @@ -1,22097 +0,0 @@ ---- -swagger: "2.0" -info: - description: "tapi-oam,tapi-photonic-media,tapi-path-computation,tapi-connectivity,tapi-dsr,tapi-notification,tapi-topology,tapi-common,tapi-odu\ - \ API generated from yang definitions" - version: "1.0" - title: "tapi-oam,tapi-photonic-media,tapi-path-computation,tapi-connectivity,tapi-dsr,tapi-notification,tapi-topology,tapi-common,tapi-odu\ - \ API" -host: "localhost:1234" -consumes: -- "application/yang-data+json" -produces: -- "application/yang-data+json" -paths: - /data/context/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Context" - parameters: [] - responses: - 200: - description: "tapi.common.Context" - schema: - $ref: "#/definitions/tapi.common.Context" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.Context" - parameters: - - in: "body" - name: "tapi.common.Context.body-param" - description: "tapi.common.Context to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.Context" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.Context" - parameters: - - in: "body" - name: "tapi.common.Context.body-param" - description: "tapi.common.Context to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.Context" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.Context" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityContext" - parameters: [] - responses: - 200: - description: "tapi.connectivity.ConnectivityContext" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityContext" - parameters: - - in: "body" - name: "tapi.connectivity.context.ConnectivityContext.body-param" - description: "tapi.connectivity.ConnectivityContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityContext" - parameters: - - in: "body" - name: "tapi.connectivity.context.ConnectivityContext.body-param" - description: "tapi.connectivity.ConnectivityContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connection={uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.Connection" - parameters: - - name: "uuid" - in: "path" - description: "Id of connection" - required: true - type: "string" - responses: - 200: - description: "tapi.connectivity.Connection" - schema: - $ref: "#/definitions/tapi.connectivity.Connection" - 400: - description: "Internal error" - ? /data/context/connectivity-context/connection={uuid}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" - 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.ConnectionEndPointRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/lower-connection={connection-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionRef" - 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.ConnectionRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - 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.NameAndValue" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/route={local-id}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.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.Route" - schema: - $ref: "#/definitions/tapi.connectivity.Route" - 400: - description: "Internal error" - ? /data/context/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" - description: "returns tapi.connectivity.ConnectionEndPointRef" - 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.ConnectionEndPointRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/route={local-id}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - 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.NameAndValue" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/supported-client-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" - 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.LinkRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.SwitchControl" - 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.SwitchControl" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - 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.NameAndValue" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/resilience-type/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of connection" - required: true - type: "string" - - name: "switch-control-uuid" - in: "path" - description: "Id of switch-control" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" - ? /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/sub-switch-control={connection-uuid},{sub-switch-control-switch-control-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.SwitchControlRef" - 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.SwitchControlRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/switch={local-id}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.Switch" - 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.Switch" - 400: - description: "Internal error" - /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/switch={local-id}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - 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.NameAndValue" - 400: - description: "Internal error" - ? /data/context/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" - description: "returns tapi.connectivity.ConnectionEndPointRef" - 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.ConnectionEndPointRef" - 400: - description: "Internal error" - ? /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/switch={local-id}/selected-route={connection-uuid},{route-local-id}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.RouteRef" - 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.RouteRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.connectivitycontext.ConnectivityService" - parameters: - - in: "body" - name: "tapi.connectivity.connectivitycontext.ConnectivityService.body-param" - description: "tapi.connectivity.connectivitycontext.ConnectivityService to\ - \ be added to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.connectivitycontext.ConnectivityService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.connectivitycontext.ConnectivityService" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.connectivity.connectivitycontext.ConnectivityService" - schema: - $ref: "#/definitions/tapi.connectivity.connectivitycontext.ConnectivityService" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.connectivitycontext.ConnectivityService" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.connectivitycontext.ConnectivityService.body-param" - description: "tapi.connectivity.connectivitycontext.ConnectivityService to\ - \ be added to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.connectivitycontext.ConnectivityService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.connectivitycontext.ConnectivityService" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.connectivitycontext.ConnectivityService.body-param" - description: "tapi.connectivity.connectivitycontext.ConnectivityService to\ - \ be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.connectivitycontext.ConnectivityService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.connectivitycontext.ConnectivityService" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/avoid-topology={topology-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of avoid-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/connection={connection-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionRef" - 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.ConnectionRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/coroute-inclusion/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceRef" - 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.ConnectivityServiceRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceRef" - 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.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/cost-characteristic/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.CostCharacteristic" - 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.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/diversity-exclusion/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" - 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.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/diversity-exclusion={connectivity-service-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "connectivity-service-uuid" - in: "path" - description: "Id of diversity-exclusion" - required: true - type: "string" - responses: - 200: - description: "tapi.connectivity.ConnectivityServiceRef" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "connectivity-service-uuid" - in: "path" - description: "Id of diversity-exclusion" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceRef.body-param" - description: "tapi.connectivity.ConnectivityServiceRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.ConnectivityServiceRef" - 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.ConnectivityServiceRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.ConnectivityServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "connectivity-service-uuid" - in: "path" - description: "Id of diversity-exclusion" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.connectivityservice.EndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.connectivityservice.EndPoint.body-param" - description: "tapi.connectivity.connectivityservice.EndPoint to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.connectivityservice.EndPoint" - 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.connectivityservice.EndPoint" - schema: - $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.connectivity.connectivityservice.EndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.connectivityservice.EndPoint.body-param" - description: "tapi.connectivity.connectivityservice.EndPoint to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.connectivity.connectivityservice.EndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.connectivityservice.EndPoint.body-param" - description: "tapi.connectivity.connectivityservice.EndPoint to be added or\ - \ updated" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.connectivity.connectivityservice.EndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.Capacity" - 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.Capacity" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.Capacity" - 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.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.BandwidthProfile" - 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.BandwidthProfile" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/total-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.connectivity.ConnectionEndPointRef" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-service-interface-point-spec/: - get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.MediaChannelServiceInterfacePointSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.MediaChannelServiceInterfacePointSpec" - schema: - $ref: "#/definitions/tapi.photonic.media.MediaChannelServiceInterfacePointSpec" - 400: - description: "Internal error" - post: - tags: - - "tapi-photonic-media" - description: "creates tapi.photonic.media.MediaChannelServiceInterfacePointSpec" - 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.photonic.media.MediaChannelServiceInterfacePointSpec.body-param" - description: "tapi.photonic.media.MediaChannelServiceInterfacePointSpec to\ - \ be added to list" - required: false - schema: - $ref: "#/definitions/tapi.photonic.media.MediaChannelServiceInterfacePointSpec" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-photonic-media" - description: "creates or updates tapi.photonic.media.MediaChannelServiceInterfacePointSpec" - 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.photonic.media.MediaChannelServiceInterfacePointSpec.body-param" - description: "tapi.photonic.media.MediaChannelServiceInterfacePointSpec to\ - \ be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.photonic.media.MediaChannelServiceInterfacePointSpec" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-photonic-media" - description: "removes tapi.photonic.media.MediaChannelServiceInterfacePointSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-service-interface-point-spec/mc-pool/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.MediaChannelPoolCapabilityPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.MediaChannelPoolCapabilityPac" - schema: - $ref: "#/definitions/tapi.photonic.media.MediaChannelPoolCapabilityPac" - 400: - description: "Internal error" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-service-interface-point-spec/mc-pool/available-spectrum={upper-frequency},{lower-frequency}/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.SpectrumBand" - 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: "upper-frequency" - in: "path" - description: "Id of available-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of available-spectrum" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.photonic.media.SpectrumBand" - schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" - 400: - description: "Internal error" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-service-interface-point-spec/mc-pool/available-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" - 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: "upper-frequency" - in: "path" - description: "Id of available-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of available-spectrum" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - 400: - description: "Internal error" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-service-interface-point-spec/mc-pool/occupied-spectrum={upper-frequency},{lower-frequency}/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.SpectrumBand" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of occupied-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of occupied-spectrum" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.photonic.media.SpectrumBand" - schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" - 400: - description: "Internal error" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-service-interface-point-spec/mc-pool/occupied-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" - 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: "upper-frequency" - in: "path" - description: "Id of occupied-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of occupied-spectrum" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - 400: - description: "Internal error" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-service-interface-point-spec/mc-pool/supportable-spectrum={upper-frequency},{lower-frequency}/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.SpectrumBand" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of supportable-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of supportable-spectrum" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.photonic.media.SpectrumBand" - schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" - 400: - description: "Internal error" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-service-interface-point-spec/mc-pool/supportable-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of supportable-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of supportable-spectrum" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - 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.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/: - get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" - schema: - $ref: "#/definitions/tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" - 400: - description: "Internal error" - post: - tags: - - "tapi-photonic-media" - description: "creates tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" - 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.photonic.media.OtsiConnectivityServiceEndPointSpec.body-param" - description: "tapi.photonic.media.OtsiConnectivityServiceEndPointSpec to be\ - \ added to list" - required: false - schema: - $ref: "#/definitions/tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-photonic-media" - description: "creates or updates tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" - 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.photonic.media.OtsiConnectivityServiceEndPointSpec.body-param" - description: "tapi.photonic.media.OtsiConnectivityServiceEndPointSpec to be\ - \ added or updated" - required: false - schema: - $ref: "#/definitions/tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-photonic-media" - description: "removes tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/otsi-config/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.OtsiTerminationConfigPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.OtsiTerminationConfigPac" - schema: - $ref: "#/definitions/tapi.photonic.media.OtsiTerminationConfigPac" - 400: - description: "Internal error" - post: - tags: - - "tapi-photonic-media" - description: "creates tapi.photonic.media.OtsiTerminationConfigPac" - 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.photonic.media.OtsiTerminationConfigPac.body-param" - description: "tapi.photonic.media.OtsiTerminationConfigPac to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.photonic.media.OtsiTerminationConfigPac" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-photonic-media" - description: "creates or updates tapi.photonic.media.OtsiTerminationConfigPac" - 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.photonic.media.OtsiTerminationConfigPac.body-param" - description: "tapi.photonic.media.OtsiTerminationConfigPac to be added or\ - \ updated" - required: false - schema: - $ref: "#/definitions/tapi.photonic.media.OtsiTerminationConfigPac" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-photonic-media" - description: "removes tapi.photonic.media.OtsiTerminationConfigPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/otsi-config/application-identifier/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.ApplicationIdentifier" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.ApplicationIdentifier" - schema: - $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifier" - 400: - description: "Internal error" - post: - tags: - - "tapi-photonic-media" - description: "creates tapi.photonic.media.ApplicationIdentifier" - 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.photonic.media.ApplicationIdentifier.body-param" - description: "tapi.photonic.media.ApplicationIdentifier to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifier" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-photonic-media" - description: "creates or updates tapi.photonic.media.ApplicationIdentifier" - 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.photonic.media.ApplicationIdentifier.body-param" - description: "tapi.photonic.media.ApplicationIdentifier to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifier" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-photonic-media" - description: "removes tapi.photonic.media.ApplicationIdentifier" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/otsi-config/central-frequency/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.CentralFrequency" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.CentralFrequency" - schema: - $ref: "#/definitions/tapi.photonic.media.CentralFrequency" - 400: - description: "Internal error" - post: - tags: - - "tapi-photonic-media" - description: "creates tapi.photonic.media.CentralFrequency" - 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.photonic.media.CentralFrequency.body-param" - description: "tapi.photonic.media.CentralFrequency to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.photonic.media.CentralFrequency" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-photonic-media" - description: "creates or updates tapi.photonic.media.CentralFrequency" - 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.photonic.media.CentralFrequency.body-param" - description: "tapi.photonic.media.CentralFrequency to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.photonic.media.CentralFrequency" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-photonic-media" - description: "removes tapi.photonic.media.CentralFrequency" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/otsi-config/central-frequency/frequency-constraint/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-photonic-media" - description: "creates tapi.photonic.media.FrequencyConstraint" - 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.photonic.media.FrequencyConstraint.body-param" - description: "tapi.photonic.media.FrequencyConstraint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-photonic-media" - description: "creates or updates tapi.photonic.media.FrequencyConstraint" - 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.photonic.media.FrequencyConstraint.body-param" - description: "tapi.photonic.media.FrequencyConstraint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-photonic-media" - description: "removes tapi.photonic.media.FrequencyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/otsi-config/spectrum/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.SpectrumBand" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.SpectrumBand" - schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" - 400: - description: "Internal error" - post: - tags: - - "tapi-photonic-media" - description: "creates tapi.photonic.media.SpectrumBand" - 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.photonic.media.SpectrumBand.body-param" - description: "tapi.photonic.media.SpectrumBand to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-photonic-media" - description: "creates or updates tapi.photonic.media.SpectrumBand" - 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.photonic.media.SpectrumBand.body-param" - description: "tapi.photonic.media.SpectrumBand to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-photonic-media" - description: "removes tapi.photonic.media.SpectrumBand" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/otsi-config/spectrum/frequency-constraint/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-photonic-media" - description: "creates tapi.photonic.media.FrequencyConstraint" - 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.photonic.media.FrequencyConstraint.body-param" - description: "tapi.photonic.media.FrequencyConstraint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-photonic-media" - description: "creates or updates tapi.photonic.media.FrequencyConstraint" - 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.photonic.media.FrequencyConstraint.body-param" - description: "tapi.photonic.media.FrequencyConstraint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-photonic-media" - description: "removes tapi.photonic.media.FrequencyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/otsi-config/transmit-power/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.PowerPropertiesPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.PowerPropertiesPac" - schema: - $ref: "#/definitions/tapi.photonic.media.PowerPropertiesPac" - 400: - description: "Internal error" - post: - tags: - - "tapi-photonic-media" - description: "creates tapi.photonic.media.PowerPropertiesPac" - 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.photonic.media.PowerPropertiesPac.body-param" - description: "tapi.photonic.media.PowerPropertiesPac to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.photonic.media.PowerPropertiesPac" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-photonic-media" - description: "creates or updates tapi.photonic.media.PowerPropertiesPac" - 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.photonic.media.PowerPropertiesPac.body-param" - description: "tapi.photonic.media.PowerPropertiesPac to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.photonic.media.PowerPropertiesPac" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-photonic-media" - description: "removes tapi.photonic.media.PowerPropertiesPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/service-interface-point/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.ServiceInterfacePointRef" - 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.ServiceInterfacePointRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.ServiceInterfacePointRef" - 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.ServiceInterfacePointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.ServiceInterfacePointRef" - 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.ServiceInterfacePointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/exclude-path={path-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of exclude-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-path={path-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of include-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/include-topology={topology-uuid}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/connectivity-context/connectivity-service={uuid}/latency-characteristic/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.LatencyCharacteristic" - 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.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/name/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/name={value-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.Capacity" - 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.Capacity" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.Capacity" - 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.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.BandwidthProfile" - 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.BandwidthProfile" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/requested-capacity/total-size/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/resilience-type/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.ResilienceType" - 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.ResilienceType" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.ResilienceType" - parameters: - - name: "uuid" - 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.ResilienceType" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/risk-diversity-characteristic/: - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/connectivity-context/connectivity-service={uuid}/risk-diversity-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/connectivity-context/connectivity-service={uuid}/schedule/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.TimeRange" - 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.TimeRange" - 400: - description: "Internal error" - post: - tags: - - "tapi-connectivity" - description: "creates tapi.common.TimeRange" - 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.TimeRange" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-connectivity" - description: "creates or updates tapi.common.TimeRange" - parameters: - - name: "uuid" - 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.TimeRange" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-connectivity" - description: "removes tapi.common.TimeRange" - parameters: - - name: "uuid" - in: "path" - description: "Id of connectivity-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationContext" - parameters: [] - responses: - 200: - description: "tapi.notification.NotificationContext" - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationContext" - parameters: - - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationContext" - parameters: - - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription/: - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" - parameters: - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NotificationSubscriptionService" - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NotificationChannel" - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.Notification" - schema: - $ref: "#/definitions/tapi.notification.Notification" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of additional-info" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of changed-attributes" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NameAndValueChange" - schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of target-object-name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/tca-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.SubscriptionFilter" - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notification={uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.Notification" - schema: - $ref: "#/definitions/tapi.notification.Notification" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/additional-info={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of additional-info" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of changed-attributes" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NameAndValueChange" - schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of target-object-name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/tca-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" - /data/context/oam-context/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamContext" - parameters: [] - responses: - 200: - description: "tapi.oam.OamContext" - schema: - $ref: "#/definitions/tapi.oam.OamContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamContext" - parameters: - - in: "body" - name: "tapi.oam.context.OamContext.body-param" - description: "tapi.oam.OamContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamContext" - parameters: - - in: "body" - name: "tapi.oam.context.OamContext.body-param" - description: "tapi.oam.OamContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/meg={uuid}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.oamcontext.Meg" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.oamcontext.Meg" - schema: - $ref: "#/definitions/tapi.oam.oamcontext.Meg" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.meg.Mep" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.meg.Mep" - schema: - $ref: "#/definitions/tapi.oam.meg.Mep" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/odu-connection-end-point-spec/: - get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduConnectionEndPointSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduConnectionEndPointSpec" - schema: - $ref: "#/definitions/tapi.odu.OduConnectionEndPointSpec" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/odu-connection-end-point-spec/odu-common/: - get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduCommonPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduCommonPac" - schema: - $ref: "#/definitions/tapi.odu.OduCommonPac" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/odu-connection-end-point-spec/odu-ctp/: - get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduCtpPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduCtpPac" - schema: - $ref: "#/definitions/tapi.odu.OduCtpPac" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/odu-connection-end-point-spec/odu-protection/: - get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduProtectionPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduProtectionPac" - schema: - $ref: "#/definitions/tapi.odu.OduProtectionPac" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/odu-connection-end-point-spec/odu-term-and-adapter/: - get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduTerminationAndClientAdaptationPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduTerminationAndClientAdaptationPac" - schema: - $ref: "#/definitions/tapi.odu.OduTerminationAndClientAdaptationPac" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mep={local-id}/odu-connection-end-point-spec/odu-term-and-adapter/accepted-payload-type/: - get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduPayloadType" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduPayloadType" - schema: - $ref: "#/definitions/tapi.odu.OduPayloadType" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.meg.Mip" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.meg.Mip" - schema: - $ref: "#/definitions/tapi.oam.meg.Mip" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/: - get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduMipSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduMipSpec" - schema: - $ref: "#/definitions/tapi.odu.OduMipSpec" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-defect/: - get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduDefectPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduDefectPac" - schema: - $ref: "#/definitions/tapi.odu.OduDefectPac" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-mip/: - get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduMipPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduMipPac" - schema: - $ref: "#/definitions/tapi.odu.OduMipPac" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-mip/deg-thr/: - get: - tags: - - "tapi-odu" - description: "returns tapi.odu.DegThr" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.DegThr" - schema: - $ref: "#/definitions/tapi.odu.DegThr" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-ncm/: - get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduNcmPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduNcmPac" - schema: - $ref: "#/definitions/tapi.odu.OduNcmPac" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-pm/: - get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduPmPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduPmPac" - schema: - $ref: "#/definitions/tapi.odu.OduPmPac" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-pm/uas/: - get: - tags: - - "tapi-odu" - description: "returns tapi.odu.UasChoice" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.UasChoice" - schema: - $ref: "#/definitions/tapi.odu.UasChoice" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-tcm/: - get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduTcmMipPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduTcmMipPac" - schema: - $ref: "#/definitions/tapi.odu.OduTcmMipPac" - 400: - description: "Internal error" - /data/context/oam-context/meg={uuid}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of meg" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/oam-context/oam-job/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamJob" - parameters: - - in: "body" - name: "tapi.oam.OamJob.body-param" - description: "tapi.oam.OamJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamJob" - schema: - $ref: "#/definitions/tapi.oam.OamJob" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamJob.body-param" - description: "tapi.oam.OamJob to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamJob.body-param" - description: "tapi.oam.OamJob to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamJob" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamJob" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/oam-profile/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamProfileRef" - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/oam-service-end-point/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-job={uuid}/oam-service-end-point={oam-service-uuid},{oam-service-end-point-local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - name: "oam-service-end-point-local-id" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamServiceEndPointRef" - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - name: "oam-service-end-point-local-id" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - name: "oam-service-end-point-local-id" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPointRef.body-param" - description: "tapi.oam.OamServiceEndPointRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "oam-service-uuid" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - - name: "oam-service-end-point-local-id" - in: "path" - description: "Id of oam-service-end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.PmCurrentData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.PmCurrentData" - schema: - $ref: "#/definitions/tapi.oam.PmCurrentData" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/elapsed-time/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimeInterval" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimeInterval" - schema: - $ref: "#/definitions/tapi.common.TimeInterval" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/elapsed-time/period={unit}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "unit" - in: "path" - description: "Id of period" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/granularity-period/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.PmHistoryData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.PmHistoryData" - schema: - $ref: "#/definitions/tapi.oam.PmHistoryData" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/granularity-period/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - 400: - description: "Internal error" - ? /data/context/oam-context/oam-job={uuid}/pm-current-data={local-id}/pm-history-data={pm-history-data-local-id}/name={value-name}/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-current-data" - required: true - type: "string" - - name: "pm-history-data-local-id" - in: "path" - description: "Id of pm-history-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/oam-context/oam-job={uuid}/schedule/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimeRange" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimeRange" - schema: - $ref: "#/definitions/tapi.common.TimeRange" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.TimeRange" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.TimeRange" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.TimeRange" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimeRange.body-param" - description: "tapi.common.TimeRange to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.TimeRange" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.TimeRange" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-job" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamProfile" - parameters: - - in: "body" - name: "tapi.oam.OamProfile.body-param" - description: "tapi.oam.OamProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamProfile" - schema: - $ref: "#/definitions/tapi.oam.OamProfile" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfile.body-param" - description: "tapi.oam.OamProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfile.body-param" - description: "tapi.oam.OamProfile to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.PmBinData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmBinData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.PmBinData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.PmBinData" - schema: - $ref: "#/definitions/tapi.oam.PmBinData" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.PmBinData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmBinData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.PmBinData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmBinData.body-param" - description: "tapi.oam.PmBinData to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmBinData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.PmBinData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/granularity-period/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-bin-data={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-bin-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmThresholdData.body-param" - description: "tapi.oam.PmThresholdData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.PmThresholdData" - schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmThresholdData.body-param" - description: "tapi.oam.PmThresholdData to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.oam.PmThresholdData.body-param" - description: "tapi.oam.PmThresholdData to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.PmThresholdData" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.PmThresholdData" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/granularity-period/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 200: - description: "tapi.common.TimePeriod" - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.TimePeriod.body-param" - description: "tapi.common.TimePeriod to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.TimePeriod" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.TimePeriod" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-profile" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of pm-threshold-data" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamService" - parameters: - - in: "body" - name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamService" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamService" - schema: - $ref: "#/definitions/tapi.oam.OamService" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamService" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamService" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamService.body-param" - description: "tapi.oam.OamService to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamService" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point/: - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamServiceEndPoint" - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamServiceEndPoint.body-param" - description: "tapi.oam.OamServiceEndPoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/connectivity-service-end-point/: - get: - tags: - - "tapi-oam" - description: "returns tapi.connectivity.ConnectivityServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.connectivity.ConnectivityServiceEndPointRef" - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.connectivity.ConnectivityServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" - description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.connectivity.ConnectivityServiceEndPointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/mep/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MepRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MepRef" - schema: - $ref: "#/definitions/tapi.oam.MepRef" - 400: - description: "Internal error" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/mip/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MipRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MipRef" - schema: - $ref: "#/definitions/tapi.oam.MipRef" - 400: - description: "Internal error" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/end-point={local-id}/service-interface-point/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePointRef.body-param" - description: "tapi.common.ServiceInterfacePointRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePointRef.body-param" - description: "tapi.common.ServiceInterfacePointRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/meg/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MegRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MegRef" - schema: - $ref: "#/definitions/tapi.oam.MegRef" - 400: - description: "Internal error" - /data/context/oam-context/oam-service={uuid}/name/: - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/oam-context/oam-service={uuid}/name={value-name}/: - get: - tags: - - "tapi-oam" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/oam-context/oam-service={uuid}/oam-profile/: - get: - tags: - - "tapi-oam" - description: "returns tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.OamProfileRef" - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - 400: - description: "Internal error" - post: - tags: - - "tapi-oam" - description: "creates tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-oam" - description: "creates or updates tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - - in: "body" - name: "tapi.oam.OamProfileRef.body-param" - description: "tapi.oam.OamProfileRef to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.oam.OamProfileRef" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-oam" - description: "removes tapi.oam.OamProfileRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of oam-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathComputationContext" - parameters: [] - responses: - 200: - description: "tapi.path.computation.PathComputationContext" - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationContext" - parameters: - - in: "body" - name: "tapi.path.computation.PathComputationContext.body-param" - description: "tapi.path.computation.PathComputationContext to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathComputationContext" - parameters: - - in: "body" - name: "tapi.path.computation.PathComputationContext.body-param" - description: "tapi.path.computation.PathComputationContext to be added or\ - \ updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathComputationContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationService" - parameters: - - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathComputationService" - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathComputationService.body-param" - description: "tapi.path.computation.PathComputationService to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathComputationService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - 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.PathComputationService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathComputationService" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - 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.PathServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathServiceEndPoint" - schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathServiceEndPoint.body-param" - description: "tapi.path.computation.PathServiceEndPoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.Capacity" - 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.Capacity" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.Capacity" - 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.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.Capacity" - 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.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.BandwidthProfile" - 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.BandwidthProfile" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.BandwidthProfile" - 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.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - 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.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/total-size/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - 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.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/service-interface-point/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathObjectiveFunction" - schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathObjectiveFunction.body-param" - description: "tapi.path.computation.PathObjectiveFunction to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathObjectiveFunction.body-param" - description: "tapi.path.computation.PathObjectiveFunction to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathObjectiveFunction" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathOptimizationConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathOptimizationConstraint.body-param" - description: "tapi.path.computation.PathOptimizationConstraint to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.PathOptimizationConstraint.body-param" - description: "tapi.path.computation.PathOptimizationConstraint to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.PathOptimizationConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.RoutingConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.RoutingConstraint.body-param" - description: "tapi.path.computation.RoutingConstraint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.RoutingConstraint.body-param" - description: "tapi.path.computation.RoutingConstraint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic/: - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.RiskCharacteristic.body-param" - description: "tapi.topology.RiskCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.TopologyConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-path-computation" - description: "creates tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.TopologyConstraint.body-param" - description: "tapi.path.computation.TopologyConstraint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-path-computation" - description: "creates or updates tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - in: "body" - name: "tapi.path.computation.TopologyConstraint.body-param" - description: "tapi.path.computation.TopologyConstraint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-path-computation" - description: "removes tapi.path.computation.TopologyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/avoid-topology={topology-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of avoid-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of exclude-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of exclude-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/exclude-path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of exclude-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of include-link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-node={topology-uuid},{node-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.NodeRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of include-node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-path={path-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.PathRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "path-uuid" - in: "path" - description: "Id of include-path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.PathRef" - schema: - $ref: "#/definitions/tapi.path.computation.PathRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint/include-topology={topology-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path-comp-service" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of include-topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.Path" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.Path" - schema: - $ref: "#/definitions/tapi.path.computation.Path" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/link={topology-uuid},{link-uuid}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LinkRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LinkRef" - schema: - $ref: "#/definitions/tapi.topology.LinkRef" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/name={value-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.path.computation.RoutingConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - responses: - 200: - description: "tapi.path.computation.RoutingConstraint" - schema: - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/path-computation-context/path={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-path-computation" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of path" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-diversity-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/service-interface-point/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.context.ServiceInterfacePoint" - parameters: - - in: "body" - name: "tapi.common.context.ServiceInterfacePoint.body-param" - description: "tapi.common.context.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.context.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.context.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.context.ServiceInterfacePoint" - schema: - $ref: "#/definitions/tapi.common.context.ServiceInterfacePoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.context.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.context.ServiceInterfacePoint.body-param" - description: "tapi.common.context.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.context.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.context.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.context.ServiceInterfacePoint.body-param" - description: "tapi.common.context.ServiceInterfacePoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.context.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.context.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/available-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/: - get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.MediaChannelServiceInterfacePointSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.MediaChannelServiceInterfacePointSpec" - schema: - $ref: "#/definitions/tapi.photonic.media.MediaChannelServiceInterfacePointSpec" - 400: - description: "Internal error" - post: - tags: - - "tapi-photonic-media" - description: "creates tapi.photonic.media.MediaChannelServiceInterfacePointSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.photonic.media.MediaChannelServiceInterfacePointSpec.body-param" - description: "tapi.photonic.media.MediaChannelServiceInterfacePointSpec to\ - \ be added to list" - required: false - schema: - $ref: "#/definitions/tapi.photonic.media.MediaChannelServiceInterfacePointSpec" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-photonic-media" - description: "creates or updates tapi.photonic.media.MediaChannelServiceInterfacePointSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.photonic.media.MediaChannelServiceInterfacePointSpec.body-param" - description: "tapi.photonic.media.MediaChannelServiceInterfacePointSpec to\ - \ be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.photonic.media.MediaChannelServiceInterfacePointSpec" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-photonic-media" - description: "removes tapi.photonic.media.MediaChannelServiceInterfacePointSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/mc-pool/: - get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.MediaChannelPoolCapabilityPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.MediaChannelPoolCapabilityPac" - schema: - $ref: "#/definitions/tapi.photonic.media.MediaChannelPoolCapabilityPac" - 400: - description: "Internal error" - ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/mc-pool/available-spectrum={upper-frequency},{lower-frequency}/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.SpectrumBand" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of available-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of available-spectrum" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.photonic.media.SpectrumBand" - schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" - 400: - description: "Internal error" - ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/mc-pool/available-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of available-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of available-spectrum" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - 400: - description: "Internal error" - ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/mc-pool/occupied-spectrum={upper-frequency},{lower-frequency}/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.SpectrumBand" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of occupied-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of occupied-spectrum" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.photonic.media.SpectrumBand" - schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" - 400: - description: "Internal error" - ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/mc-pool/occupied-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of occupied-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of occupied-spectrum" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - 400: - description: "Internal error" - ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/mc-pool/supportable-spectrum={upper-frequency},{lower-frequency}/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.SpectrumBand" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of supportable-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of supportable-spectrum" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.photonic.media.SpectrumBand" - schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" - 400: - description: "Internal error" - ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/mc-pool/supportable-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of supportable-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of supportable-spectrum" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/: - get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.OtsiServiceInterfacePointSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.OtsiServiceInterfacePointSpec" - schema: - $ref: "#/definitions/tapi.photonic.media.OtsiServiceInterfacePointSpec" - 400: - description: "Internal error" - post: - tags: - - "tapi-photonic-media" - description: "creates tapi.photonic.media.OtsiServiceInterfacePointSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.photonic.media.OtsiServiceInterfacePointSpec.body-param" - description: "tapi.photonic.media.OtsiServiceInterfacePointSpec to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.photonic.media.OtsiServiceInterfacePointSpec" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-photonic-media" - description: "creates or updates tapi.photonic.media.OtsiServiceInterfacePointSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.photonic.media.OtsiServiceInterfacePointSpec.body-param" - description: "tapi.photonic.media.OtsiServiceInterfacePointSpec to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.photonic.media.OtsiServiceInterfacePointSpec" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-photonic-media" - description: "removes tapi.photonic.media.OtsiServiceInterfacePointSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/otsi-capability/: - get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.OtsiCapabilityPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.OtsiCapabilityPac" - schema: - $ref: "#/definitions/tapi.photonic.media.OtsiCapabilityPac" - 400: - description: "Internal error" - ? /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/otsi-capability/supportable-application-identifier={application-code}/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.ApplicationIdentifier" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "application-code" - in: "path" - description: "Id of supportable-application-identifier" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.ApplicationIdentifier" - schema: - $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifier" - 400: - description: "Internal error" - ? /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/otsi-capability/supportable-lower-central-frequency={central-frequency}/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.CentralFrequency" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "central-frequency" - in: "path" - description: "Id of supportable-lower-central-frequency" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.photonic.media.CentralFrequency" - schema: - $ref: "#/definitions/tapi.photonic.media.CentralFrequency" - 400: - description: "Internal error" - ? /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/otsi-capability/supportable-lower-central-frequency={central-frequency}/frequency-constraint/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "central-frequency" - in: "path" - description: "Id of supportable-lower-central-frequency" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - 400: - description: "Internal error" - ? /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/otsi-capability/supportable-upper-central-frequency={central-frequency}/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.CentralFrequency" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "central-frequency" - in: "path" - description: "Id of supportable-upper-central-frequency" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.photonic.media.CentralFrequency" - schema: - $ref: "#/definitions/tapi.photonic.media.CentralFrequency" - 400: - description: "Internal error" - ? /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/otsi-capability/supportable-upper-central-frequency={central-frequency}/frequency-constraint/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "central-frequency" - in: "path" - description: "Id of supportable-upper-central-frequency" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/otsi-capability/total-power-warn-threshold/: - get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.TotalPowerThresholdPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.TotalPowerThresholdPac" - schema: - $ref: "#/definitions/tapi.photonic.media.TotalPowerThresholdPac" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyContext" - parameters: [] - responses: - 200: - description: "tapi.topology.TopologyContext" - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-topology" - description: "creates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.context.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-topology" - description: "creates or updates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.context.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-topology" - description: "removes tapi.topology.TopologyContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/topology-context/nw-topology-service/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NetworkTopologyService" - parameters: [] - responses: - 200: - description: "tapi.topology.NetworkTopologyService" - schema: - $ref: "#/definitions/tapi.topology.NetworkTopologyService" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "topology-uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Topology" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Topology" - schema: - $ref: "#/definitions/tapi.topology.Topology" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Link" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Link" - schema: - $ref: "#/definitions/tapi.topology.Link" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/resilience-type/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ValidationMechanism" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "validation-mechanism" - in: "path" - description: "Id of validation-mechanism" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ValidationMechanism" - schema: - $ref: "#/definitions/tapi.topology.ValidationMechanism" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.topology.Node" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.topology.Node" - schema: - $ref: "#/definitions/tapi.topology.topology.Node" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroup" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroup" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-rule-group-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroupRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.InterRuleGroup" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.InterRuleGroup" - schema: - $ref: "#/definitions/tapi.topology.InterRuleGroup" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-rule-group-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroupRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Rule" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Rule" - schema: - $ref: "#/definitions/tapi.topology.Rule" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Rule" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Rule" - schema: - $ref: "#/definitions/tapi.topology.Rule" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.node.OwnedNodeEdgePoint" - parameters: - - name: "uuid" - 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.OwnedNodeEdgePoint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/: - get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - 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.context.topologycontext.topology.node.ownednodeedgepoint.CepList" - schema: - $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ceplist.ConnectionEndPoint" - parameters: - - name: "uuid" - 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.ceplist.ConnectionEndPoint" - schema: - $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/aggregated-connection-end-point={topology-uuid},{aggregated-connection-end-point-node-uuid},{node-edge-point-uuid},{aggregated-connection-end-point-connection-end-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.connectivity.ConnectionEndPointRef" - parameters: - - name: "uuid" - 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.ConnectionEndPointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/client-node-edge-point={topology-uuid},{client-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - 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.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/media-channel-assembly-spec/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.MediaChannelAssemblySpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.MediaChannelAssemblySpec" - schema: - $ref: "#/definitions/tapi.photonic.media.MediaChannelAssemblySpec" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/media-channel-connection-end-point-spec/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.MediaChannelConnectionEndPointSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.MediaChannelConnectionEndPointSpec" - schema: - $ref: "#/definitions/tapi.photonic.media.MediaChannelConnectionEndPointSpec" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/media-channel-connection-end-point-spec/media-channel/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.MediaChannelPropertiesPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.MediaChannelPropertiesPac" - schema: - $ref: "#/definitions/tapi.photonic.media.MediaChannelPropertiesPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/media-channel-connection-end-point-spec/media-channel/measured-power-egress/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.PowerPropertiesPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.PowerPropertiesPac" - schema: - $ref: "#/definitions/tapi.photonic.media.PowerPropertiesPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/media-channel-connection-end-point-spec/media-channel/measured-power-ingress/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.PowerPropertiesPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.PowerPropertiesPac" - schema: - $ref: "#/definitions/tapi.photonic.media.PowerPropertiesPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/media-channel-connection-end-point-spec/media-channel/occupied-spectrum/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.SpectrumBand" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.SpectrumBand" - schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/media-channel-connection-end-point-spec/media-channel/occupied-spectrum/frequency-constraint/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MepMipList" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MepMipList" - schema: - $ref: "#/definitions/tapi.oam.MepMipList" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mep={meg-uuid},{mep-local-id}/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MepRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "meg-uuid" - in: "path" - description: "Id of mep" - required: true - type: "string" - - name: "mep-local-id" - in: "path" - description: "Id of mep" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MepRef" - schema: - $ref: "#/definitions/tapi.oam.MepRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mip={meg-uuid},{mip-local-id}/ - : get: - tags: - - "tapi-oam" - description: "returns tapi.oam.MipRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "meg-uuid" - in: "path" - description: "Id of mip" - required: true - type: "string" - - name: "mip-local-id" - in: "path" - description: "Id of mip" - required: true - type: "string" - responses: - 200: - description: "tapi.oam.MipRef" - schema: - $ref: "#/definitions/tapi.oam.MipRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/name={value-name}/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/ - : get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduConnectionEndPointSpec" - parameters: - - name: "uuid" - 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.odu.OduConnectionEndPointSpec" - schema: - $ref: "#/definitions/tapi.odu.OduConnectionEndPointSpec" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-common/ - : get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduCommonPac" - parameters: - - name: "uuid" - 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.odu.OduCommonPac" - schema: - $ref: "#/definitions/tapi.odu.OduCommonPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-ctp/ - : get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduCtpPac" - parameters: - - name: "uuid" - 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.odu.OduCtpPac" - schema: - $ref: "#/definitions/tapi.odu.OduCtpPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-protection/ - : get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduProtectionPac" - parameters: - - name: "uuid" - 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.odu.OduProtectionPac" - schema: - $ref: "#/definitions/tapi.odu.OduProtectionPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-term-and-adapter/ - : get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduTerminationAndClientAdaptationPac" - parameters: - - name: "uuid" - 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.odu.OduTerminationAndClientAdaptationPac" - schema: - $ref: "#/definitions/tapi.odu.OduTerminationAndClientAdaptationPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-term-and-adapter/accepted-payload-type/ - : get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduPayloadType" - parameters: - - name: "uuid" - 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.odu.OduPayloadType" - schema: - $ref: "#/definitions/tapi.odu.OduPayloadType" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ots-connection-end-point-spec/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.OtsConnectionEndPointSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.OtsConnectionEndPointSpec" - schema: - $ref: "#/definitions/tapi.photonic.media.OtsConnectionEndPointSpec" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ots-connection-end-point-spec/ots-media-channel/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.MediaChannelPropertiesPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.MediaChannelPropertiesPac" - schema: - $ref: "#/definitions/tapi.photonic.media.MediaChannelPropertiesPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ots-connection-end-point-spec/ots-media-channel/measured-power-egress/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.PowerPropertiesPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.PowerPropertiesPac" - schema: - $ref: "#/definitions/tapi.photonic.media.PowerPropertiesPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ots-connection-end-point-spec/ots-media-channel/measured-power-ingress/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.PowerPropertiesPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.PowerPropertiesPac" - schema: - $ref: "#/definitions/tapi.photonic.media.PowerPropertiesPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ots-connection-end-point-spec/ots-media-channel/occupied-spectrum/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.SpectrumBand" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.SpectrumBand" - schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ots-connection-end-point-spec/ots-media-channel/occupied-spectrum/frequency-constraint/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-assembly-connection-end-point-spec/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.OtsiAssemblyConnectionEndPointSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.OtsiAssemblyConnectionEndPointSpec" - schema: - $ref: "#/definitions/tapi.photonic.media.OtsiAssemblyConnectionEndPointSpec" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-assembly-connection-end-point-spec/fec-parameters/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.FecPropertiesPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.FecPropertiesPac" - schema: - $ref: "#/definitions/tapi.photonic.media.FecPropertiesPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-assembly-connection-end-point-spec/otsi-adapter/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.OtsiGserverAdaptationPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.OtsiGserverAdaptationPac" - schema: - $ref: "#/definitions/tapi.photonic.media.OtsiGserverAdaptationPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.OtsiConnectionEndPointSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.OtsiConnectionEndPointSpec" - schema: - $ref: "#/definitions/tapi.photonic.media.OtsiConnectionEndPointSpec" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.OtsiTerminationPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.OtsiTerminationPac" - schema: - $ref: "#/definitions/tapi.photonic.media.OtsiTerminationPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/laser-properties/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.LaserPropertiesPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.LaserPropertiesPac" - schema: - $ref: "#/definitions/tapi.photonic.media.LaserPropertiesPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/received-power/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.PowerPropertiesPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.PowerPropertiesPac" - schema: - $ref: "#/definitions/tapi.photonic.media.PowerPropertiesPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/selected-application-identifier/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.ApplicationIdentifier" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.ApplicationIdentifier" - schema: - $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifier" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/selected-central-frequency/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.CentralFrequency" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.CentralFrequency" - schema: - $ref: "#/definitions/tapi.photonic.media.CentralFrequency" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/selected-central-frequency/frequency-constraint/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/selected-spectrum/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.SpectrumBand" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.SpectrumBand" - schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/selected-spectrum/frequency-constraint/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/transmited-power/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.PowerPropertiesPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.PowerPropertiesPac" - schema: - $ref: "#/definitions/tapi.photonic.media.PowerPropertiesPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/parent-node-edge-point/ - : get: - tags: - - "tapi-connectivity" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "connection-end-point-uuid" - in: "path" - description: "Id of connection-end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "service-interface-point-uuid" - in: "path" - description: "Id of mapped-service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/media-channel-node-edge-point-spec/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.MediaChannelNodeEdgePointSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.MediaChannelNodeEdgePointSpec" - schema: - $ref: "#/definitions/tapi.photonic.media.MediaChannelNodeEdgePointSpec" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/media-channel-node-edge-point-spec/mc-pool/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.MediaChannelPoolCapabilityPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.photonic.media.MediaChannelPoolCapabilityPac" - schema: - $ref: "#/definitions/tapi.photonic.media.MediaChannelPoolCapabilityPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/media-channel-node-edge-point-spec/mc-pool/available-spectrum={upper-frequency},{lower-frequency}/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.SpectrumBand" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of available-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of available-spectrum" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.photonic.media.SpectrumBand" - schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/media-channel-node-edge-point-spec/mc-pool/available-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of available-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of available-spectrum" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/media-channel-node-edge-point-spec/mc-pool/occupied-spectrum={upper-frequency},{lower-frequency}/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.SpectrumBand" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of occupied-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of occupied-spectrum" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.photonic.media.SpectrumBand" - schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/media-channel-node-edge-point-spec/mc-pool/occupied-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of occupied-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of occupied-spectrum" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/media-channel-node-edge-point-spec/mc-pool/supportable-spectrum={upper-frequency},{lower-frequency}/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.SpectrumBand" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of supportable-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of supportable-spectrum" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.photonic.media.SpectrumBand" - schema: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/media-channel-node-edge-point-spec/mc-pool/supportable-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ - : get: - tags: - - "tapi-photonic-media" - description: "returns tapi.photonic.media.FrequencyConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "upper-frequency" - in: "path" - description: "Id of supportable-spectrum" - required: true - type: "integer" - format: "int32" - - name: "lower-frequency" - in: "path" - description: "Id of supportable-spectrum" - required: true - type: "integer" - format: "int32" - responses: - 200: - description: "tapi.photonic.media.FrequencyConstraint" - schema: - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/odu-node-edge-point-spec/ - : get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduNodeEdgePointSpec" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduNodeEdgePointSpec" - schema: - $ref: "#/definitions/tapi.odu.OduNodeEdgePointSpec" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/odu-node-edge-point-spec/odu-pool/ - : get: - tags: - - "tapi-odu" - description: "returns tapi.odu.OduPoolPac" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.odu.OduPoolPac" - schema: - $ref: "#/definitions/tapi.odu.OduPoolPac" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /operations/compute-p-2-p-path/: - post: - tags: - - "tapi-path-computation" - parameters: - - in: "body" - name: "tapi.path.computation.computep2ppath.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.path.computation.computep2ppath.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.path.computation.ComputeP2PPath" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-connectivity-service/: - post: - tags: - - "tapi-connectivity" - parameters: - - in: "body" - name: "tapi.connectivity.createconnectivityservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.connectivity.createconnectivityservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.connectivity.CreateConnectivityService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-notification-subscription-service/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.CreateNotificationSubscriptionService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-oam-job/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.createoamjob.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.createoamjob.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.CreateOamJob" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-oam-service-end-point/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.createoamserviceendpoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.createoamserviceendpoint.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.CreateOamServiceEndPoint" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-oam-service/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.createoamservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.createoamservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.CreateOamService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/delete-connectivity-service/: - post: - tags: - - "tapi-connectivity" - 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/delete-notification-subscription-service/: - post: - tags: - - "tapi-notification" - 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/delete-oam-job/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.deleteoamjob.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.deleteoamjob.Input" - responses: - 201: - description: "No response" - 400: - description: "Internal error" - /operations/delete-oam-service-end-point/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.deleteoamserviceendpoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.deleteoamserviceendpoint.Input" - responses: - 201: - description: "No response" - 400: - description: "Internal error" - /operations/delete-oam-service/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.deleteoamservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.deleteoamservice.Input" - responses: - 201: - description: "No response" - 400: - description: "Internal error" - /operations/delete-p-2-p-path/: - post: - tags: - - "tapi-path-computation" - 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/get-connection-details/: - post: - tags: - - "tapi-connectivity" - 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/get-connection-end-point-details/: - post: - tags: - - "tapi-connectivity" - 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/get-connectivity-service-details/: - post: - tags: - - "tapi-connectivity" - 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/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/get-link-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.getlinkdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.getlinkdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetLinkDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-meg/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.getmeg.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.getmeg.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.GetMeg" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-node-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.getnodedetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.getnodedetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetNodeDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-node-edge-point-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.getnodeedgepointdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetNodeEdgePointDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-list/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.getnotificationlist.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.getnotificationlist.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-subscription-service-details/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-subscription-service-list/: - post: - tags: - - "tapi-notification" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-oam-job/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.getoamjob.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.getoamjob.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.GetOamJob" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-oam-service-end-point/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.getoamserviceendpoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.getoamserviceendpoint.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.GetOamServiceEndPoint" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-oam-service-list/: - post: - tags: - - "tapi-oam" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.GetOamServiceList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-oam-service/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.getoamservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.getoamservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.GetOamService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-service-interface-point-details/: - post: - tags: - - "tapi-common" - parameters: - - in: "body" - name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.common.GetServiceInterfacePointDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-service-interface-point-list/: - post: - tags: - - "tapi-common" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.common.GetServiceInterfacePointList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-supported-notification-types/: - post: - tags: - - "tapi-notification" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetSupportedNotificationTypes" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-topology-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.gettopologydetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.gettopologydetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetTopologyDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-topology-list/: - post: - tags: - - "tapi-topology" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetTopologyList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/optimize-p-2-p-path/: - post: - tags: - - "tapi-path-computation" - 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/update-connectivity-service/: - post: - tags: - - "tapi-connectivity" - 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/update-notification-subscription-service/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.UpdateNotificationSubscriptionService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-oam-job/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.updateoamjob.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.updateoamjob.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.UpdateOamJob" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-oam-service-end-point/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.updateoamserviceendpoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.updateoamserviceendpoint.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.UpdateOamServiceEndPoint" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-oam-service/: - post: - tags: - - "tapi-oam" - parameters: - - in: "body" - name: "tapi.oam.updateoamservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.oam.updateoamservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.oam.UpdateOamService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-service-interface-point/: - post: - tags: - - "tapi-common" - parameters: - - in: "body" - name: "tapi.common.updateserviceinterfacepoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.common.updateserviceinterfacepoint.Input" - responses: - 201: - description: "No response" - 400: - description: "Internal error" -definitions: - tapi.common.AdminStatePac: - type: "object" - properties: - operational-state: - description: "none" - $ref: "#/definitions/tapi.common.OperationalState" - lifecycle-state: - description: "none" - $ref: "#/definitions/tapi.common.LifecycleState" - administrative-state: - description: "none" - $ref: "#/definitions/tapi.common.AdministrativeState" - tapi.common.AdministrativeState: - type: "string" - enum: - - "LOCKED" - - "UNLOCKED" - tapi.common.BandwidthProfile: - type: "object" - properties: - committed-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - coupling-flag: - type: "boolean" - description: "none" - default: false - bw-profile-type: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfileType" - peak-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - committed-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - peak-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - color-aware: - type: "boolean" - description: "none" - default: false - tapi.common.BandwidthProfileType: - type: "string" - enum: - - "MEF_10.x" - - "RFC_2697" - - "RFC_2698" - - "RFC_4115" - tapi.common.Capacity: - type: "object" - properties: - bandwidth-profile: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfile" - total-size: - description: "Total capacity of the TopologicalEntity in MB/s. In case of\ - \ bandwidthProfile, this is expected to same as the committedInformationRate." - $ref: "#/definitions/tapi.common.CapacityValue" - tapi.common.CapacityPac: - type: "object" - properties: - available-capacity: - description: "Capacity available to be assigned." - $ref: "#/definitions/tapi.common.Capacity" - total-potential-capacity: - description: "An optimistic view of the capacity of the TopologicalEntity\ - \ assuming that any shared capacity is available to be taken." - $ref: "#/definitions/tapi.common.Capacity" - tapi.common.CapacityUnit: - type: "string" - enum: - - "TB" - - "TBPS" - - "GB" - - "GBPS" - - "MB" - - "MBPS" - - "KB" - - "KBPS" - - "GHz" - - "MHz" - tapi.common.CapacityValue: - type: "object" - properties: - value: - type: "integer" - format: "int32" - description: "none" - unit: - description: "none" - $ref: "#/definitions/tapi.common.CapacityUnit" - tapi.common.Context: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.connectivity.ContextAugmentation4" - - $ref: "#/definitions/tapi.notification.ContextAugmentation2" - - $ref: "#/definitions/tapi.oam.ContextAugmentation1" - - $ref: "#/definitions/tapi.path.computation.ContextAugmentation3" - - $ref: "#/definitions/tapi.topology.ContextAugmentation5" - - type: "object" - properties: - service-interface-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.context.ServiceInterfacePoint" - description: "none" - tapi.common.DirectiveValue: - type: "string" - enum: - - "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.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" - 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.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.TimeInterval: - type: "object" - properties: - period: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.TimePeriod" - tapi.common.TimePeriod: - type: "object" - properties: - value: - type: "integer" - format: "int32" - description: "none" - unit: - description: "none" - $ref: "#/definitions/tapi.common.TimeUnit" - tapi.common.TimeRange: - type: "object" - properties: - end-time: - type: "string" - description: "none" - start-time: - type: "string" - description: "none" - tapi.common.TimeUnit: - type: "string" - enum: - - "YEARS" - - "MONTHS" - - "DAYS" - - "HOURS" - - "MINUTES" - - "SECONDS" - - "MILLISECONDS" - - "MICROSECONDS" - - "NANOSECONDS" - - "PICOSECONDS" - tapi.common.context.ServiceInterfacePoint: - allOf: - - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - - $ref: "#/definitions/tapi.photonic.media.ServiceInterfacePointAugmentation1" - - $ref: "#/definitions/tapi.photonic.media.ServiceInterfacePointAugmentation2" - 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.getserviceinterfacepointlist.output.Sip" - tapi.common.getserviceinterfacepointlist.Output: - type: "object" - properties: - sip: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.getserviceinterfacepointlist.output.Sip" - tapi.common.getserviceinterfacepointlist.output.Sip: - allOf: - - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - - $ref: "#/definitions/tapi.photonic.media.SipAugmentation1" - - $ref: "#/definitions/tapi.photonic.media.SipAugmentation2" - 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.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" - 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" - 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.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.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" - 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" - coroute-inclusion: - description: "none" - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" - tapi.connectivity.ConnectivityContext: - type: "object" - properties: - connectivity-service: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ConnectivityService" - connection: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.Connection" - tapi.connectivity.ConnectivityService: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" - - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - - type: "object" - properties: - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" - connection: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ConnectionRef" - description: "none" - 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" - 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" - 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.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.ContextAugmentation4: - 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.OwnedNodeEdgePointAugmentation3: - type: "object" - properties: - cep-list: - description: "none" - $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.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.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" - description: "The FC Route (FcRoute) object class models the individual routes\ - \ of an FC. \r\n The route of an FC object is represented by\ - \ a list of FCs at a lower level. \r\n Note that depending\ - \ on the service supported by an FC, an the FC can have multiple routes." - 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.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.UpdateConnectivityService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.connectivity.updateconnectivityservice.Output" - tapi.connectivity.ceplist.ConnectionEndPoint: - allOf: - - $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" - - $ref: "#/definitions/tapi.oam.ConnectionEndPointAugmentation2" - - $ref: "#/definitions/tapi.odu.ConnectionEndPointAugmentation1" - - $ref: "#/definitions/tapi.photonic.media.ConnectionEndPointAugmentation3" - - $ref: "#/definitions/tapi.photonic.media.ConnectionEndPointAugmentation4" - - $ref: "#/definitions/tapi.photonic.media.ConnectionEndPointAugmentation5" - - $ref: "#/definitions/tapi.photonic.media.ConnectionEndPointAugmentation6" - - $ref: "#/definitions/tapi.photonic.media.ConnectionEndPointAugmentation7" - tapi.connectivity.connectivitycontext.ConnectivityService: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" - - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - - type: "object" - properties: - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" - connection: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ConnectionRef" - description: "none" - tapi.connectivity.connectivityservice.EndPoint: - allOf: - - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" - - $ref: "#/definitions/tapi.photonic.media.EndPointAugmentation1" - - $ref: "#/definitions/tapi.photonic.media.EndPointAugmentation2" - tapi.connectivity.context.topologycontext.topology.node.ownednodeedgepoint.CepList: - allOf: - - type: "object" - properties: - connection-end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" - description: "none" - 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.connectivityservice.EndPoint" - 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.createconnectivityservice.output.Service" - tapi.connectivity.createconnectivityservice.output.Service: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" - - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - - type: "object" - properties: - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" - connection: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ConnectionRef" - description: "none" - tapi.connectivity.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.getconnectionendpointdetails.output.ConnectionEndPoint" - tapi.connectivity.getconnectionendpointdetails.output.ConnectionEndPoint: - allOf: - - $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" - - $ref: "#/definitions/tapi.photonic.media.ConnectionEndPointAugmentation1" - - $ref: "#/definitions/tapi.photonic.media.ConnectionEndPointAugmentation2" - - $ref: "#/definitions/tapi.photonic.media.ConnectionEndPointAugmentation3" - 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.getconnectivityservicedetails.output.Service" - tapi.connectivity.getconnectivityservicedetails.output.Service: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" - - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - - type: "object" - properties: - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" - connection: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ConnectionRef" - description: "none" - tapi.connectivity.getconnectivityservicelist.Output: - type: "object" - properties: - service: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.getconnectivityservicelist.output.Service" - tapi.connectivity.getconnectivityservicelist.output.Service: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" - - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - - type: "object" - properties: - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" - connection: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ConnectionRef" - description: "none" - tapi.connectivity.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.connectivityservice.EndPoint" - 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.updateconnectivityservice.output.Service" - tapi.connectivity.updateconnectivityservice.output.Service: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" - - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - - $ref: "#/definitions/tapi.path.computation.RoutingConstraint" - - $ref: "#/definitions/tapi.path.computation.TopologyConstraint" - - type: "object" - properties: - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" - connection: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.connectivity.ConnectionRef" - description: "none" - tapi.notification.AlarmInfo: - type: "object" - properties: - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedSeverityType" - probable-cause: - type: "string" - description: "none" - service-affecting: - description: "none" - $ref: "#/definitions/tapi.notification.ServiceAffecting" - is-transient: - type: "boolean" - description: "none" - default: false - tapi.notification.ContextAugmentation2: - type: "object" - properties: - notification-context: - description: "Augments the base TAPI Context with NotificationService information" - $ref: "#/definitions/tapi.notification.NotificationContext" - 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.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.NotificationContext: - type: "object" - properties: - notif-subscription: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - notification: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.Notification" - tapi.notification.NotificationSubscriptionService: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - notification: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.Notification" - notification-channel: - description: "none" - $ref: "#/definitions/tapi.notification.NotificationChannel" - subscription-state: - description: "none" - $ref: "#/definitions/tapi.notification.SubscriptionState" - supported-object-types: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.ObjectType" - supported-notification-types: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.NotificationType" - subscription-filter: - description: "none" - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - description: "none" - tapi.notification.NotificationType: - type: "string" - enum: - - "OBJECT_CREATION" - - "OBJECT_DELETION" - - "ATTRIBUTE_VALUE_CHANGE" - - "ALARM_EVENT" - - "THRESHOLD_CROSSING_ALERT" - tapi.notification.ObjectType: - type: "string" - enum: - - "TOPOLOGY" - - "NODE" - - "LINK" - - "CONNECTION" - - "PATH" - - "CONNECTIVITY_SERVICE" - - "VIRTUAL_NETWORK_SERVICE" - - "PATH_COMPUTATION_SERVICE" - - "NODE_EDGE_POINT" - - "SERVICE_INTERFACE_POINT" - - "CONNECTION_END_POINT" - - "MAINTENANCE_ENTITY_GROUP" - - "MAINTENANCE_ENTITY" - - "MEG_END_POINT" - - "MEG_INTERMEDIATE_POINT" - - "SWITCH_CONTROL" - - "SWITCH" - - "ROUTE" - - "NODE_RULE_GROUP" - - "INTER_RULE_GROUP" - - "RULE" - - "OAM_JOB" - tapi.notification.PerceivedSeverityType: - type: "string" - enum: - - "CRITICAL" - - "MAJOR" - - "MINOR" - - "WARNING" - - "CLEARED" - tapi.notification.PerceivedTcaSeverity: - type: "string" - enum: - - "WARNING" - - "CLEAR" - tapi.notification.ServiceAffecting: - type: "string" - enum: - - "SERVICE_AFFECTING" - - "NOT_SERVICE_AFFECTING" - - "UNKNOWN" - 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.SubscriptionState: - type: "string" - enum: - - "SUSPENDED" - - "ACTIVE" - tapi.notification.TcaInfo: - type: "object" - properties: - threshold-crossing: - description: "none" - $ref: "#/definitions/tapi.notification.ThresholdCrossingType" - threshold-parameter: - type: "string" - description: "none" - is-transient: - type: "boolean" - description: "none" - default: false - threshold-value: - type: "integer" - format: "int32" - description: "none" - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedTcaSeverity" - suspect-interval-flag: - type: "boolean" - description: "none" - default: false - measurement-interval: - type: "string" - description: "none" - tapi.notification.ThresholdCrossingType: - type: "string" - enum: - - "THRESHOLD_ABOVE" - - "THRESHOLD_BELOW" - - "CLEARED" - tapi.notification.UpdateNotificationSubscriptionService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Output" - tapi.notification.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.oam.ConnectionEndPointAugmentation2: - type: "object" - properties: - mep-mip-list: - description: "none" - $ref: "#/definitions/tapi.oam.MepMipList" - x-augmentation: - prefix: "tapi-oam" - namespace: "urn:onf:otcc:yang:tapi-oam" - tapi.oam.ContextAugmentation1: - type: "object" - properties: - oam-context: - description: "Augments the base TAPI Context with OamService information" - $ref: "#/definitions/tapi.oam.OamContext" - x-augmentation: - prefix: "tapi-oam" - namespace: "urn:onf:otcc:yang:tapi-oam" - tapi.oam.CreateOamJob: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.createoamjob.Output" - tapi.oam.CreateOamService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.createoamservice.Output" - tapi.oam.CreateOamServiceEndPoint: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.createoamserviceendpoint.Output" - tapi.oam.GetMeg: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.getmeg.Output" - tapi.oam.GetOamJob: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.getoamjob.Output" - tapi.oam.GetOamService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.getoamservice.Output" - tapi.oam.GetOamServiceEndPoint: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.getoamserviceendpoint.Output" - tapi.oam.GetOamServiceList: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.getoamservicelist.Output" - tapi.oam.Meg: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.common.OperationalStatePac" - - type: "object" - properties: - meg-identifier: - type: "string" - description: "none" - meg-level: - type: "integer" - format: "int32" - description: "none" - mip: - type: "array" - description: "ME may 0, 1, or more MIPs" - items: - $ref: "#/definitions/tapi.oam.Mip" - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - mep: - type: "array" - description: "1. ME may have 0 MEPs (case of transit domains where at least\ - \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case\ - \ of edge domaind, where the peer MEP is ouside the managed domain)\r\n\ - \ 3. ME may have 2 MEPs" - items: - $ref: "#/definitions/tapi.oam.Mep" - direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" - description: "none" - tapi.oam.MegRef: - type: "object" - properties: - meg-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:uuid" - tapi.oam.Mep: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - $ref: "#/definitions/tapi.common.OperationalStatePac" - - type: "object" - properties: - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - peer-mep-identifier: - type: "array" - description: "none" - items: - type: "string" - mep-identifier: - type: "string" - description: "none" - direction: - description: "none" - $ref: "#/definitions/tapi.common.TerminationDirection" - description: "none" - tapi.oam.MepMipList: - type: "object" - properties: - mip: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.MipRef" - mep: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.MepRef" - tapi.oam.MepRef: - allOf: - - $ref: "#/definitions/tapi.oam.MegRef" - - type: "object" - properties: - mep-local-id: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:mep/tapi-oam:local-id" - description: "none" - tapi.oam.Mip: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - description: "none" - tapi.oam.MipRef: - allOf: - - $ref: "#/definitions/tapi.oam.MegRef" - - type: "object" - properties: - mip-local-id: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:mip/tapi-oam:local-id" - description: "none" - tapi.oam.OamConstraint: - type: "object" - properties: - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - meg-level: - type: "integer" - format: "int32" - description: "none" - direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" - tapi.oam.OamContext: - type: "object" - properties: - oam-service: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamService" - oam-profile: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamProfile" - oam-job: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamJob" - meg: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.Meg" - tapi.oam.OamJob: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - schedule: - description: "none" - $ref: "#/definitions/tapi.common.TimeRange" - oam-profile: - description: "none" - $ref: "#/definitions/tapi.oam.OamProfileRef" - pm-current-data: - type: "array" - description: "Granularity period of the CurrentData identifies the specific\ - \ CurrentData instance in the scope of this OamJob.\r\n \ - \ For example, typically at least\r\n one 15min\ - \ and\r\n one 24hr;\r\n optionally\ - \ one additional configurable (< 15min)" - items: - $ref: "#/definitions/tapi.oam.PmCurrentData" - creation-time: - type: "string" - description: "none" - oam-service-end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPointRef" - oam-job-type: - type: "string" - description: "none" - description: "none" - tapi.oam.OamProfile: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - pm-threshold-data: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.PmThresholdData" - pm-bin-data: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.PmBinData" - description: "none" - tapi.oam.OamProfileRef: - type: "object" - properties: - oam-profile-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-profile/tapi-oam:uuid" - tapi.oam.OamService: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.oam.OamConstraint" - - type: "object" - properties: - oam-profile: - description: "none" - $ref: "#/definitions/tapi.oam.OamProfileRef" - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - meg: - description: "none" - $ref: "#/definitions/tapi.oam.MegRef" - description: "none" - tapi.oam.OamServiceEndPoint: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - peer-mep-identifier: - type: "array" - description: "This attribute models the MI_PeerMEP_ID[i] defined in G.8021\ - \ and configured as specified in G.8051. It provides the identifiers of\ - \ the MEPs which are peer to the subject MEP.\r\n This\ - \ attribute is not specified in case the OSEP relates to the provisioing\ - \ of an MIP.\r\n In case of P2P, there is only one\ - \ peer" - items: - type: "string" - connectivity-service-end-point: - description: "none" - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" - mip: - description: "none" - $ref: "#/definitions/tapi.oam.MipRef" - service-interface-point: - description: "none" - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - mep: - description: "none" - $ref: "#/definitions/tapi.oam.MepRef" - mep-identifier: - type: "string" - description: "This attribute contains the identifier of the MEP.\r\n \ - \ This attribute is empty in case the OSEP relates to\ - \ the provisioing of an MIP.\r\n " - direction: - description: "none" - $ref: "#/definitions/tapi.common.PortDirection" - description: "none" - tapi.oam.OamServiceEndPointRef: - allOf: - - $ref: "#/definitions/tapi.oam.OamServiceRef" - - type: "object" - properties: - oam-service-end-point-local-id: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:end-point/tapi-oam:local-id" - description: "none" - tapi.oam.OamServiceRef: - type: "object" - properties: - oam-service-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:uuid" - tapi.oam.PmBinData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - description: "none" - tapi.oam.PmCurrentData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - elapsed-time: - description: "none" - $ref: "#/definitions/tapi.common.TimeInterval" - pm-history-data: - type: "array" - description: "in case of 24hr Current Data, at least 1 History Data.\r\n\ - \ In case of 15min Current Data, at least 16 History\ - \ Data.\r\n In case of <15min, the number of History\ - \ Data shall be able to cover a span of 4 hours." - items: - $ref: "#/definitions/tapi.oam.PmHistoryData" - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - suspect-interval-flag: - type: "boolean" - description: "This attribute is used to indicate that the performance data\ - \ for the current period may not be reliable. Some reasons for this to\ - \ occur are:\r\n – Suspect data were detected by the\ - \ actual resource doing data collection.\r\n – Transition\ - \ of the administrativeState attribute to/from the 'lock' state.\r\n \ - \ – Transition of the operationalState to/from the 'disabled'\ - \ state.\r\n – Scheduler setting that inhibits the\ - \ collection function.\r\n – The performance counters\ - \ were reset during the interval.\r\n – The currentData\ - \ (or subclass) object instance was created during the monitoring period." - default: false - timestamp: - type: "string" - description: "This attribute indicates the start of the current monitoring\ - \ interval.\r\n The value is bound to the quarter of\ - \ an hour in case of a 15 minute interval and bound to the hour in case\ - \ of a 24 hour interval." - description: "none" - tapi.oam.PmHistoryData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - period-end-time: - type: "string" - description: "none" - suspect-interval-flag: - type: "boolean" - description: "This attribute indicates that the performance data may not\ - \ be reliable." - default: false - description: "none" - tapi.oam.PmThresholdData: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - is-transient: - type: "boolean" - description: "none" - default: false - granularity-period: - description: "none" - $ref: "#/definitions/tapi.common.TimePeriod" - description: "none" - tapi.oam.UpdateOamJob: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.updateoamjob.Output" - tapi.oam.UpdateOamService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.updateoamservice.Output" - tapi.oam.UpdateOamServiceEndPoint: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.oam.updateoamserviceendpoint.Output" - tapi.oam.createoamjob.Input: - type: "object" - properties: - schedule: - type: "string" - description: "none" - oam-service-end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - oam-job-type: - type: "string" - description: "none" - oam-profile: - description: "none" - $ref: "#/definitions/tapi.oam.OamProfile" - state: - type: "string" - description: "none" - tapi.oam.createoamjob.Output: - type: "object" - properties: - oam-job: - description: "none" - $ref: "#/definitions/tapi.oam.OamJob" - tapi.oam.createoamservice.Input: - type: "object" - properties: - oam-constraint: - description: "none" - $ref: "#/definitions/tapi.oam.OamConstraint" - state: - type: "string" - description: "none" - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.oam.createoamservice.Output: - type: "object" - properties: - service: - description: "none" - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.createoamserviceendpoint.Input: - type: "object" - properties: - peer-mep-identifier: - type: "array" - description: "none" - items: - type: "string" - service-id: - type: "string" - description: "none" - sip-id: - type: "string" - description: "none" - c-sep-id: - type: "string" - description: "none" - mep-identifier: - type: "string" - description: "none" - state: - type: "string" - description: "none" - layer: - type: "string" - description: "none" - direction: - type: "string" - description: "none" - tapi.oam.createoamserviceendpoint.Output: - type: "object" - properties: - end-point: - description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.oam.deleteoamjob.Input: - type: "object" - properties: - job-id: - type: "string" - description: "none" - tapi.oam.deleteoamservice.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - tapi.oam.deleteoamserviceendpoint.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - o-sep-id: - type: "string" - description: "none" - tapi.oam.getmeg.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - tapi.oam.getmeg.Output: - type: "object" - properties: - meg: - description: "none" - $ref: "#/definitions/tapi.oam.Meg" - tapi.oam.getoamjob.Input: - type: "object" - properties: - job-id: - type: "string" - description: "none" - tapi.oam.getoamjob.Output: - type: "object" - properties: - oam-job: - description: "none" - $ref: "#/definitions/tapi.oam.OamJob" - tapi.oam.getoamservice.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - tapi.oam.getoamservice.Output: - type: "object" - properties: - service: - description: "none" - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.getoamserviceendpoint.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - o-sep-id: - type: "string" - description: "none" - tapi.oam.getoamserviceendpoint.Output: - type: "object" - properties: - end-point: - description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.oam.getoamservicelist.Output: - type: "object" - properties: - service: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.meg.Mep: - allOf: - - $ref: "#/definitions/tapi.oam.Mep" - - $ref: "#/definitions/tapi.odu.MepAugmentation1" - tapi.oam.meg.Mip: - allOf: - - $ref: "#/definitions/tapi.oam.Mip" - - $ref: "#/definitions/tapi.odu.MipAugmentation1" - tapi.oam.oamcontext.Meg: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.common.OperationalStatePac" - - type: "object" - properties: - meg-identifier: - type: "string" - description: "none" - meg-level: - type: "integer" - format: "int32" - description: "none" - mip: - type: "array" - description: "ME may 0, 1, or more MIPs" - items: - $ref: "#/definitions/tapi.oam.meg.Mip" - layer-protocol-name: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - mep: - type: "array" - description: "1. ME may have 0 MEPs (case of transit domains where at least\ - \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case\ - \ of edge domaind, where the peer MEP is ouside the managed domain)\r\n\ - \ 3. ME may have 2 MEPs" - items: - $ref: "#/definitions/tapi.oam.meg.Mep" - direction: - description: "none" - $ref: "#/definitions/tapi.common.ForwardingDirection" - description: "none" - tapi.oam.updateoamjob.Input: - type: "object" - properties: - job-id: - type: "string" - description: "none" - schedule: - type: "string" - description: "none" - oam-profile: - description: "none" - $ref: "#/definitions/tapi.oam.OamProfile" - state: - type: "string" - description: "none" - tapi.oam.updateoamjob.Output: - type: "object" - properties: - oam-job: - description: "none" - $ref: "#/definitions/tapi.oam.OamJob" - tapi.oam.updateoamservice.Input: - type: "object" - properties: - oam-constraint: - description: "none" - $ref: "#/definitions/tapi.oam.OamConstraint" - service-id: - type: "string" - description: "none" - state: - type: "string" - description: "none" - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.oam.updateoamservice.Output: - type: "object" - properties: - service: - description: "none" - $ref: "#/definitions/tapi.oam.OamService" - tapi.oam.updateoamserviceendpoint.Input: - type: "object" - properties: - service-id: - type: "string" - description: "none" - o-sep-id: - type: "string" - description: "none" - state: - type: "string" - description: "none" - tapi.oam.updateoamserviceendpoint.Output: - type: "object" - properties: - end-point: - description: "none" - $ref: "#/definitions/tapi.oam.OamServiceEndPoint" - tapi.odu.ConnectionEndPointAugmentation1: - type: "object" - properties: - odu-connection-end-point-spec: - description: "none" - $ref: "#/definitions/tapi.odu.OduConnectionEndPointSpec" - x-augmentation: - prefix: "tapi-odu" - namespace: "urn:onf:otcc:yang:tapi-odu" - tapi.odu.DegThr: - type: "object" - properties: - deg-thr-value: - type: "integer" - format: "int32" - description: "Percentage of detected errored blocks" - percentage-granularity: - description: "none" - $ref: "#/definitions/tapi.odu.PercentageGranularity" - deg-thr-type: - description: "Number of errored blocks" - $ref: "#/definitions/tapi.odu.DegThrType" - tapi.odu.DegThrType: - type: "string" - enum: - - "PERCENTAGE" - - "NUMBER_ERRORED_BLOCKS" - tapi.odu.MappingType: - type: "string" - enum: - - "AMP" - - "BMP" - - "GFP-F" - - "GMP" - - "TTP_GFP_BMP" - - "NULL" - tapi.odu.MepAugmentation1: - type: "object" - properties: - odu-connection-end-point-spec: - description: "none" - $ref: "#/definitions/tapi.odu.OduConnectionEndPointSpec" - x-augmentation: - prefix: "tapi-odu" - namespace: "urn:onf:otcc:yang:tapi-odu" - tapi.odu.MipAugmentation1: - type: "object" - properties: - odu-mip-spec: - description: "none" - $ref: "#/definitions/tapi.odu.OduMipSpec" - x-augmentation: - prefix: "tapi-odu" - namespace: "urn:onf:otcc:yang:tapi-odu" - tapi.odu.OduCommonPac: - type: "object" - properties: - odu-rate-tolerance: - type: "integer" - format: "int32" - description: "This attribute indicates the rate tolerance of the ODU termination\ - \ point. \r\n Valid values are real value in the unit\ - \ of ppm. \r\n Standardized values are defined in Table\ - \ 7-2/G.709." - odu-rate: - type: "integer" - format: "int32" - description: "This attribute indicates the rate of the ODU terminatino point.\ - \ \r\n This attribute is Set at create; i.e., once created\ - \ it cannot be changed directly. \r\n In case of resizable\ - \ ODU flex, its value can be changed via HAO (not directly on the attribute).\ - \ \r\n " - odu-type: - type: "string" - description: "This attribute specifies the type of the ODU termination point." - tapi.odu.OduConnectionEndPointSpec: - type: "object" - properties: - odu-term-and-adapter: - description: "none" - $ref: "#/definitions/tapi.odu.OduTerminationAndClientAdaptationPac" - odu-common: - description: "none" - $ref: "#/definitions/tapi.odu.OduCommonPac" - odu-ctp: - description: "none" - $ref: "#/definitions/tapi.odu.OduCtpPac" - odu-protection: - description: "none" - $ref: "#/definitions/tapi.odu.OduProtectionPac" - tapi.odu.OduCtpPac: - type: "object" - properties: - accepted-msi: - type: "string" - description: "This attribute is applicable when the ODU CTP object instance\ - \ represents a lower order ODU1 or ODU2 CTP Sink at the client layer of\ - \ the ODU3P/ODU12 adaptation function or represents a lower order ODUj CTP\ - \ Sink at the client layer of the ODUP/ODUj-21 adaptation function. This\ - \ attribute is a 1-byte field that represents the accepted multiplex structure\ - \ of the adaptation function. " - tributary-port-number: - type: "integer" - format: "int32" - description: "This attribute identifies the tributary port number that is\ - \ associated with the ODU CTP.\r\n range of type : The\ - \ value range depends on the size of the Tributary Port Number (TPN) field\ - \ used which depends on th server-layer ODU or OTU.\r\n \ - \ In case of ODUk mapping into OTUk, there is no TPN field, so the tributaryPortNumber\ - \ shall be zero.\r\n In case of LO ODUj mapping over\ - \ ODU1, ODU2 or ODU3, the TPN is encoded in a 6-bit field so the value range\ - \ is 0-63. See clause 14.4.1/G.709-2016.\r\n In case\ - \ of LO ODUj mapping over ODU4, the TPN is encoded in a 7-bit field so the\ - \ value range is 0-127. See clause 14.4.1.4/G.709-2016.\r\n \ - \ In case of ODUk mapping over ODUCn, the TPN is encoded in a 14-bit\ - \ field so the value range is 0-16383. See clause 20.4.1.1/G.709-2016.\r\ - \n " - tributary-slot-list: - type: "array" - description: "This attribute contains a set of distinct (i.e. unique) integers\ - \ (e.g. 2, 3, 5, 9, 15 representing the tributary slots TS2, TS3, TS5, TS9\ - \ and TS15) which represents the resources occupied by the Low Order ODU\ - \ Link Connection (e.g. carrying an ODUflex with a bit rate of 6.25G). \r\ - \n This attribute applies when the LO ODU_ ConnectionTerminationPoint\ - \ connects with an HO ODU_TrailTerminationPoint object. \r\n \ - \ It will not apply if this ODU_ ConnectionTerminationPoint object\ - \ directly connects to an OTU_TrailTerminationPoint object (i.e. OTU has\ - \ no trib slots). \r\n The upper bound of the integer\ - \ allowed in this set is a function of the HO-ODU server layer to which\ - \ the ODU connection has been mapped (adapted). \r\n \ - \ Thus, for example, M=8/32/80 for ODU2/ODU3/ODU4 server layers (respectively).\ - \ Note that the value of this attribute can be changed only in the case\ - \ of ODUflex and has to be through specific operations (i.e. not be changing\ - \ the attribute tributarySlotList directly)." - items: - type: "integer" - format: "int32" - tapi.odu.OduDefectPac: - type: "object" - properties: - oci: - type: "boolean" - description: "Open Connection Indicator" - default: false - lck: - type: "boolean" - description: "Locked" - default: false - bdi: - type: "boolean" - description: "Backward Defect Indication" - default: false - ssf: - type: "boolean" - description: "Server Signal Failure" - default: false - deg: - type: "boolean" - description: "Signal Degraded" - default: false - tim: - type: "boolean" - description: "Trail Trace Identifier Mismatch" - default: false - tapi.odu.OduMipPac: - type: "object" - properties: - tim-det-mode: - description: "This attribute indicates the mode of the Trace Identifier Mismatch\ - \ (TIM) Detection function allowed values: OFF, SAPIonly, DAPIonly, SAPIandDAPI" - $ref: "#/definitions/tapi.odu.TimDetMo" - ex-dapi: - type: "string" - description: "The Expected Destination Access Point Identifier (ExDAPI), provisioned\ - \ by the managing system, to be compared with the TTI accepted at the overhead\ - \ position of the sink for the purpose of checking the integrity of connectivity." - deg-m: - type: "integer" - format: "int32" - description: "This attribute indicates the threshold level for declaring a\ - \ Degraded Signal defect (dDEG). A dDEG shall be declared if DegM consecutive\ - \ bad PM Seconds are detected." - acti: - type: "string" - description: "The Trail Trace Identifier (TTI) information recovered (Accepted)\ - \ from the TTI overhead position at the sink of a trail." - ex-sapi: - type: "string" - description: "The Expected Source Access Point Identifier (ExSAPI), provisioned\ - \ by the managing system, to be compared with the TTI accepted at the overhead\ - \ position of the sink for the purpose of checking the integrity of connectivity.\r\ - \n " - deg-thr: - description: "This attribute indicates the threshold level for declaring a\ - \ performance monitoring (PM) Second to be bad. The value of the threshold\ - \ can be provisioned in terms of number of errored blocks or in terms of\ - \ percentage of errored blocks. For percentage-based specification, in order\ - \ to support provision of less than 1%, the specification consists of two\ - \ fields. The first field indicates the granularity of percentage. For examples,\ - \ in 1%, in 0.1%, or in 0.01%, etc. The second field indicates the multiple\ - \ of the granularity. For number of errored block based, the value is a\ - \ positive integer." - $ref: "#/definitions/tapi.odu.DegThr" - tim-act-disabled: - type: "boolean" - description: "This attribute provides the control capability for the managing\ - \ system to enable or disable the Consequent Action function when detecting\ - \ Trace Identifier Mismatch (TIM) at the trail termination sink." - default: true - tapi.odu.OduMipSpec: - type: "object" - properties: - odu-mip: - description: "none" - $ref: "#/definitions/tapi.odu.OduMipPac" - odu-pm: - description: "none" - $ref: "#/definitions/tapi.odu.OduPmPac" - odu-ncm: - description: "none" - $ref: "#/definitions/tapi.odu.OduNcmPac" - odu-tcm: - description: "none" - $ref: "#/definitions/tapi.odu.OduTcmMipPac" - odu-defect: - description: "none" - $ref: "#/definitions/tapi.odu.OduDefectPac" - tapi.odu.OduNamedPayloadType: - type: "string" - enum: - - "UNKNOWN" - - "UNINTERPRETABLE" - tapi.odu.OduNcmPac: - type: "object" - properties: - tcm-fields-in-use: - type: "array" - description: "This attribute indicates the used TCM fields of the ODU OH." - items: - type: "integer" - format: "int32" - tapi.odu.OduNodeEdgePointSpec: - type: "object" - properties: - odu-pool: - description: "none" - $ref: "#/definitions/tapi.odu.OduPoolPac" - tapi.odu.OduPayloadType: - type: "object" - properties: - hex-payload-type: - type: "integer" - format: "int32" - description: "none" - named-payload-type: - description: "none" - $ref: "#/definitions/tapi.odu.OduNamedPayloadType" - tapi.odu.OduPmPac: - type: "object" - properties: - f-ses: - type: "integer" - format: "int32" - description: "Far-end Severely Errored Second" - n-bbe: - type: "integer" - format: "int32" - description: "Near-end Background Block Error" - f-bbe: - type: "integer" - format: "int32" - description: "Far-end Background Block Error" - uas: - description: "UnAvailable Second" - $ref: "#/definitions/tapi.odu.UasChoice" - n-ses: - type: "integer" - format: "int32" - description: "Near-end Severely Errored Second" - tapi.odu.OduPoolPac: - type: "object" - properties: - client-capacity: - type: "integer" - format: "int32" - description: "none" - max-client-size: - type: "integer" - format: "int32" - description: "none" - max-client-instances: - type: "integer" - format: "int32" - description: "none" - tapi.odu.OduProtectionPac: - type: "object" - properties: - aps-enable: - type: "boolean" - description: "This attribute is for enabling/disabling the automatic protection\ - \ switching (APS) capability at the transport adaptation function that is\ - \ represented by the ODU_ConnectionTerminationPoint object class. It triggers\ - \ the MI_APS_EN signal to the transport adaptation function." - default: true - aps-level: - type: "integer" - format: "int32" - description: "This attribute is for configuring the automatic protection switching\ - \ (APS) level that should operate at the transport adaptation function that\ - \ is represented by the ODU_ConnectionTerminationPoint object class. It\ - \ triggers the MI_APS_LVL signal to the transport adaptation function. The\ - \ value 0 means path and the values 1 through 6 mean TCM level 1 through\ - \ 6 respectively." - tapi.odu.OduSlotSize: - type: "string" - enum: - - "1G25" - - "2G5" - tapi.odu.OduTcmMipPac: - type: "object" - properties: - tcm-field: - type: "integer" - format: "int32" - description: "This attribute indicates the tandem connection monitoring field\ - \ of the ODU OH." - tapi.odu.OduTerminationAndClientAdaptationPac: - type: "object" - properties: - configured-mapping-type: - description: "This attributes indicates the configured mapping type." - $ref: "#/definitions/tapi.odu.MappingType" - auto-payload-type: - type: "boolean" - description: "This attribute is applicable when the ODU CTP object instance\ - \ represents a lower order ODU CTP Source at the client layer of the ODUP/ODUj-21\ - \ adaptation function. The value of true of this attribute configures that\ - \ the adaptation source function shall fall back to the payload type PT=20\ - \ if the conditions specified in 14.3.10.1/G.798 are satisfied. " - default: false - accepted-payload-type: - description: "This attribute is applicable when the ODU CTP object instance\ - \ represents a lower order ODU CTP Sink at the client layer of the ODUP/ODU[i]j\ - \ or ODUP/ODUj-21 adaptation function. \r\n This attribute\ - \ is a 2-digit Hex code that indicates the new accepted payload type.\r\n\ - \ Valid values are defined in Table 15-8 of ITU-T Recommendation\ - \ G.709 with one additional value UN_INTERPRETABLE." - $ref: "#/definitions/tapi.odu.OduPayloadType" - opu-tributary-slot-size: - description: "This attribute is applicable for ODU2 and ODU3 CTP only. It\ - \ indicates the slot size of the ODU CTP." - $ref: "#/definitions/tapi.odu.OduSlotSize" - configured-client-type: - type: "string" - description: "This attribute configures the type of the client CTP of the\ - \ server ODU TTP." - tapi.odu.OwnedNodeEdgePointAugmentation1: - type: "object" - properties: - odu-node-edge-point-spec: - description: "Augments the base LayerProtocol information in NodeEdgePoint\ - \ with ODU-specific information" - $ref: "#/definitions/tapi.odu.OduNodeEdgePointSpec" - x-augmentation: - prefix: "tapi-odu" - namespace: "urn:onf:otcc:yang:tapi-odu" - tapi.odu.PercentageGranularity: - type: "string" - enum: - - "ONES" - - "ONE_TENTHS" - - "ONE_HUNDREDTHS" - - "ONE_THOUSANDTHS" - tapi.odu.TimDetMo: - type: "string" - enum: - - "DAPI" - - "SAPI" - - "BOTH" - - "OFF" - tapi.odu.UasChoice: - type: "object" - properties: - fuas: - type: "integer" - format: "int32" - description: "none" - bidirectional: - type: "boolean" - description: "none" - default: true - nuas: - type: "integer" - format: "int32" - description: "none" - uas: - type: "integer" - format: "int32" - description: "none" - tapi.path.computation.ComputeP2PPath: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.path.computation.computep2ppath.Output" - tapi.path.computation.ContextAugmentation3: - 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.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.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.PathOptimizationConstraint: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - traffic-interruption: - description: "none" - $ref: "#/definitions/tapi.common.DirectiveValue" - description: "none" - 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.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.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 - 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" - 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.TopologyConstraint: - type: "object" - properties: - include-node: - type: "array" - description: "This is a loose constraint - that is it is unordered and could\ - \ be a partial list" - items: - $ref: "#/definitions/tapi.topology.NodeRef" - exclude-link: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.LinkRef" - avoid-topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - exclude-path: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.path.computation.PathRef" - include-link: - type: "array" - description: "This is a loose constraint - that is it is unordered and could\ - \ be a partial list " - items: - $ref: "#/definitions/tapi.topology.LinkRef" - preferred-transport-layer: - type: "array" - description: "soft constraint requested by client to indicate the layer(s)\ - \ of transport connection that it prefers to carry the service. This could\ - \ be same as the service layer or one of the supported server layers" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - exclude-node: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRef" - include-topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - include-path: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.path.computation.PathRef" - 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.photonic.media.AdjustmentGranularity: - type: "string" - enum: - - "G_100GHZ" - - "G_50GHZ" - - "G_25GHZ" - - "G_12_5GHZ" - - "G_6_25GHZ" - - "G_3_125GHZ" - - "UNCONSTRAINED" - tapi.photonic.media.ApplicationIdentifier: - type: "object" - properties: - application-identifier-type: - description: "The ITU-T recommendation which defines the application code\ - \ format." - $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifierType" - application-code: - type: "string" - description: "none" - tapi.photonic.media.ApplicationIdentifierType: - type: "string" - enum: - - "PROPRIETARY" - - "ITUT_G959_1" - - "ITUT_G698_1" - - "ITUT_G698_2" - - "ITUT_G696_1" - - "ITUT_G695" - tapi.photonic.media.CentralFrequency: - type: "object" - properties: - central-frequency: - type: "integer" - format: "int32" - description: "The central frequency of the laser specified in MHz. It is the\ - \ oscillation frequency of the corresponding electromagnetic wave. " - frequency-constraint: - description: "none" - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - tapi.photonic.media.ConnectionEndPointAugmentation1: - type: "object" - properties: - otsi-assembly-connection-end-point-spec: - description: "none" - $ref: "#/definitions/tapi.photonic.media.OtsiAssemblyConnectionEndPointSpec" - x-augmentation: - prefix: "tapi-photonic-media" - namespace: "urn:onf:otcc:yang:tapi-photonic-media" - tapi.photonic.media.ConnectionEndPointAugmentation2: - type: "object" - properties: - otsi-connection-end-point-spec: - description: "none" - $ref: "#/definitions/tapi.photonic.media.OtsiConnectionEndPointSpec" - x-augmentation: - prefix: "tapi-photonic-media" - namespace: "urn:onf:otcc:yang:tapi-photonic-media" - tapi.photonic.media.ConnectionEndPointAugmentation3: - type: "object" - properties: - otsi-assembly-connection-end-point-spec: - description: "none" - $ref: "#/definitions/tapi.photonic.media.OtsiAssemblyConnectionEndPointSpec" - x-augmentation: - prefix: "tapi-photonic-media" - namespace: "urn:onf:otcc:yang:tapi-photonic-media" - tapi.photonic.media.ConnectionEndPointAugmentation4: - type: "object" - properties: - ots-connection-end-point-spec: - description: "none" - $ref: "#/definitions/tapi.photonic.media.OtsConnectionEndPointSpec" - x-augmentation: - prefix: "tapi-photonic-media" - namespace: "urn:onf:otcc:yang:tapi-photonic-media" - tapi.photonic.media.ConnectionEndPointAugmentation5: - type: "object" - properties: - otsi-connection-end-point-spec: - description: "Augments the base LayerProtocol information in ConnectionEndPoint\ - \ with OCH-specific information" - $ref: "#/definitions/tapi.photonic.media.OtsiConnectionEndPointSpec" - x-augmentation: - prefix: "tapi-photonic-media" - namespace: "urn:onf:otcc:yang:tapi-photonic-media" - tapi.photonic.media.ConnectionEndPointAugmentation6: - type: "object" - properties: - media-channel-connection-end-point-spec: - description: "none" - $ref: "#/definitions/tapi.photonic.media.MediaChannelConnectionEndPointSpec" - x-augmentation: - prefix: "tapi-photonic-media" - namespace: "urn:onf:otcc:yang:tapi-photonic-media" - tapi.photonic.media.ConnectionEndPointAugmentation7: - type: "object" - properties: - media-channel-assembly-spec: - description: "none" - $ref: "#/definitions/tapi.photonic.media.MediaChannelAssemblySpec" - x-augmentation: - prefix: "tapi-photonic-media" - namespace: "urn:onf:otcc:yang:tapi-photonic-media" - tapi.photonic.media.EndPointAugmentation1: - type: "object" - properties: - media-channel-service-interface-point-spec: - description: "none" - $ref: "#/definitions/tapi.photonic.media.MediaChannelServiceInterfacePointSpec" - x-augmentation: - prefix: "tapi-photonic-media" - namespace: "urn:onf:otcc:yang:tapi-photonic-media" - tapi.photonic.media.EndPointAugmentation2: - type: "object" - properties: - otsi-connectivity-service-end-point-spec: - description: "none" - $ref: "#/definitions/tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" - x-augmentation: - prefix: "tapi-photonic-media" - namespace: "urn:onf:otcc:yang:tapi-photonic-media" - tapi.photonic.media.FecPropertiesPac: - type: "object" - properties: - uncorrectable-bytes: - type: "integer" - format: "int32" - description: "Bytes that could not be corrected by FEC" - corrected-bits: - type: "integer" - format: "int32" - description: "Bits corrected between those that were received corrupted" - pre-fec-ber: - type: "integer" - format: "int32" - description: "counter: bit error rate before correction by FEC" - uncorrectable-bits: - type: "integer" - format: "int32" - description: "Bits that could not be corrected by FEC" - corrected-bytes: - type: "integer" - format: "int32" - description: "Bytes corrected between those that were received corrupted" - post-fec-ber: - type: "integer" - format: "int32" - description: "counter: bit error rate after correction by FEC" - tapi.photonic.media.FrequencyConstraint: - type: "object" - properties: - adjustment-granularity: - description: "Adjustment granularity in Gigahertz. As per ITU-T G.694.1, it\ - \ is used to calculate nominal central frequency (in THz)" - $ref: "#/definitions/tapi.photonic.media.AdjustmentGranularity" - grid-type: - description: "Specifies the frequency grid standard used to determine the\ - \ nominal central frequency and frequency slot width" - $ref: "#/definitions/tapi.photonic.media.GridType" - tapi.photonic.media.GridType: - type: "string" - enum: - - "DWDM" - - "CWDM" - - "FLEX" - - "GRIDLESS" - - "UNSPECIFIED" - tapi.photonic.media.LaserControlStatusType: - type: "string" - enum: - - "ON" - - "OFF" - - "PULSING" - - "UNDEFINED" - tapi.photonic.media.LaserControlType: - type: "string" - enum: - - "FORCED-ON" - - "FORCED-OFF" - - "AUTOMATIC-LASER-SHUTDOWN" - - "UNDEFINED" - tapi.photonic.media.LaserPropertiesPac: - type: "object" - properties: - laser-application-type: - description: "The type of laser, its operational wavelengths, and its applications.\ - \ String size 255." - $ref: "#/definitions/tapi.photonic.media.LaserType" - laser-bias-current: - type: "string" - description: "The Bias current of the laser that is the medium polarization\ - \ current of the laser." - laser-temperature: - type: "string" - description: "The temperature of the laser" - laser-status: - description: "none" - $ref: "#/definitions/tapi.photonic.media.LaserControlStatusType" - tapi.photonic.media.LaserType: - type: "string" - enum: - - "PUMP" - - "MODULATED" - - "PULSE" - tapi.photonic.media.MediaChannelAssemblySpec: - type: "object" - tapi.photonic.media.MediaChannelConnectionEndPointSpec: - type: "object" - properties: - media-channel: - description: "none" - $ref: "#/definitions/tapi.photonic.media.MediaChannelPropertiesPac" - tapi.photonic.media.MediaChannelNodeEdgePointSpec: - type: "object" - properties: - mc-pool: - description: "none" - $ref: "#/definitions/tapi.photonic.media.MediaChannelPoolCapabilityPac" - tapi.photonic.media.MediaChannelPoolCapabilityPac: - type: "object" - properties: - available-spectrum: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" - supportable-spectrum: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" - occupied-spectrum: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" - tapi.photonic.media.MediaChannelPropertiesPac: - type: "object" - properties: - occupied-spectrum: - description: "none" - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" - measured-power-egress: - description: "none" - $ref: "#/definitions/tapi.photonic.media.PowerPropertiesPac" - measured-power-ingress: - description: "none" - $ref: "#/definitions/tapi.photonic.media.PowerPropertiesPac" - tapi.photonic.media.MediaChannelServiceInterfacePointSpec: - type: "object" - properties: - mc-pool: - description: "none" - $ref: "#/definitions/tapi.photonic.media.MediaChannelPoolCapabilityPac" - tapi.photonic.media.ModulationTechnique: - type: "string" - enum: - - "RZ" - - "NRZ" - - "BPSK" - - "DPSK" - - "QPSK" - - "8QAM" - - "16QAM" - - "PAM4" - - "PAM8" - - "UNDEFINED" - tapi.photonic.media.NodeEdgePointAugmentation1: - type: "object" - properties: - media-channel-node-edge-point-spec: - description: "none" - $ref: "#/definitions/tapi.photonic.media.MediaChannelNodeEdgePointSpec" - x-augmentation: - prefix: "tapi-photonic-media" - namespace: "urn:onf:otcc:yang:tapi-photonic-media" - tapi.photonic.media.OtsConnectionEndPointSpec: - type: "object" - properties: - ots-media-channel: - description: "none" - $ref: "#/definitions/tapi.photonic.media.MediaChannelPropertiesPac" - tapi.photonic.media.OtsiAssemblyConnectionEndPointSpec: - type: "object" - properties: - otsi-adapter: - description: "none" - $ref: "#/definitions/tapi.photonic.media.OtsiGserverAdaptationPac" - fec-parameters: - description: "none" - $ref: "#/definitions/tapi.photonic.media.FecPropertiesPac" - tapi.photonic.media.OtsiCapabilityPac: - type: "object" - properties: - supportable-lower-central-frequency: - type: "array" - description: "The lower frequency of the channel spectrum" - items: - $ref: "#/definitions/tapi.photonic.media.CentralFrequency" - supportable-application-identifier: - type: "array" - description: "The list of supportable ApplicationIdentifiers." - items: - $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifier" - supportable-modulation: - type: "array" - description: "This parameter defines the modulation used at the source" - items: - $ref: "#/definitions/tapi.photonic.media.ModulationTechnique" - total-power-warn-threshold: - description: "none" - $ref: "#/definitions/tapi.photonic.media.TotalPowerThresholdPac" - supportable-upper-central-frequency: - type: "array" - description: "The Upper frequency of the channel spectrum" - items: - $ref: "#/definitions/tapi.photonic.media.CentralFrequency" - tapi.photonic.media.OtsiConnectionEndPointSpec: - type: "object" - properties: - otsi-termination: - description: "none" - $ref: "#/definitions/tapi.photonic.media.OtsiTerminationPac" - tapi.photonic.media.OtsiConnectivityServiceEndPointSpec: - type: "object" - properties: - otsi-config: - description: "none" - $ref: "#/definitions/tapi.photonic.media.OtsiTerminationConfigPac" - tapi.photonic.media.OtsiGserverAdaptationPac: - type: "object" - properties: - number-of-otsi: - type: "integer" - format: "int32" - description: "none" - tapi.photonic.media.OtsiServiceInterfacePointSpec: - type: "object" - properties: - otsi-capability: - description: "none" - $ref: "#/definitions/tapi.photonic.media.OtsiCapabilityPac" - tapi.photonic.media.OtsiTerminationConfigPac: - type: "object" - properties: - application-identifier: - description: "This attribute indicates the selected Application Identifier." - $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifier" - central-frequency: - description: "The central frequency of the laser. It is the oscillation frequency\ - \ of the corresponding electromagnetic wave" - $ref: "#/definitions/tapi.photonic.media.CentralFrequency" - modulation: - description: "The modulation techniqu selected at the source." - $ref: "#/definitions/tapi.photonic.media.ModulationTechnique" - spectrum: - description: "none" - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" - laser-control: - description: "Laser control can be FORCED-ON, FORCED-OFF or LASER-SHUTDOWN" - $ref: "#/definitions/tapi.photonic.media.LaserControlType" - total-power-warn-threshold-lower: - type: "string" - description: "Allows to configure the Lowerpower threshold which is expected\ - \ to be different from Default, but within the Min and Max values specified\ - \ as OTSi SIP capability." - total-power-warn-threshold-upper: - type: "string" - description: "Allows to configure the Upper power threshold which is expected\ - \ to be different from Default, but within the Min and Max values specified\ - \ as OTSi SIP capability." - transmit-power: - description: "Transmit power as requested." - $ref: "#/definitions/tapi.photonic.media.PowerPropertiesPac" - tapi.photonic.media.OtsiTerminationPac: - type: "object" - properties: - selected-application-identifier: - description: "This attribute indicates the selected Application Identifier\ - \ that is used by the OCh trail termination function. The syntax of ApplicationIdentifier\ - \ is a pair {ApplicationIdentifierType, PrintableString}. The value of ApplicationIdentifierType\ - \ is either STANDARD or PROPRIETARY. The value of PrintableString represents\ - \ the standard application code as defined in the ITU-T Recommendations\ - \ or a vendor-specific proprietary code. If the ApplicationIdentifierType\ - \ is STANDARD the value of PrintableString represents a standard application\ - \ code as defined in the ITU-T Recommendations. If the ApplicationIdentifierType\ - \ is PROPRIETARY, the first six characters of the PrintableString must contain\ - \ the Hexadecimal representation of an OUI assigned to the vendor whose\ - \ implementation generated the Application Identifier; the remaining octets\ - \ of the PrintableString are unspecified. The value of this attribute of\ - \ an object instance has to be one of the values identified in the attribute\ - \ SupportableApplicationIdentifierList of the same object instance. The\ - \ values and value ranges of the optical interface parameters of a standard\ - \ application code must be consistent with those values specified in the\ - \ ITU-T Recommendation for that application code." - $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifier" - received-power: - description: "none" - $ref: "#/definitions/tapi.photonic.media.PowerPropertiesPac" - selected-central-frequency: - description: "none" - $ref: "#/definitions/tapi.photonic.media.CentralFrequency" - transmited-power: - description: "Measured power at the Transmitter." - $ref: "#/definitions/tapi.photonic.media.PowerPropertiesPac" - selected-modulation: - description: "This parameter defines the modulation used at the source" - $ref: "#/definitions/tapi.photonic.media.SelectedModulation" - laser-properties: - description: "Laser properties." - $ref: "#/definitions/tapi.photonic.media.LaserPropertiesPac" - selected-spectrum: - description: "none" - $ref: "#/definitions/tapi.photonic.media.SpectrumBand" - tapi.photonic.media.OwnedNodeEdgePointAugmentation2: - type: "object" - properties: - media-channel-node-edge-point-spec: - description: "Augments the base LayerProtocol information in NodeEdgePoint\ - \ with OCH-specific information" - $ref: "#/definitions/tapi.photonic.media.MediaChannelNodeEdgePointSpec" - x-augmentation: - prefix: "tapi-photonic-media" - namespace: "urn:onf:otcc:yang:tapi-photonic-media" - tapi.photonic.media.PowerPropertiesPac: - type: "object" - properties: - power-spectral-density: - type: "string" - description: "This describes how power of a signal is distributed over frequency\ - \ specified in nW/MHz" - total-power: - type: "string" - description: "The total power at any point in a channel specified in dBm." - tapi.photonic.media.SelectedModulation: - type: "string" - enum: - - "RZ" - - "NRZ" - - "BPSK" - - "DPSK" - - "QPSK" - - "8QAM" - - "16QAM" - - "PAM4" - - "PAM8" - - "UNDEFINED" - tapi.photonic.media.ServiceInterfacePointAugmentation1: - type: "object" - properties: - media-channel-service-interface-point-spec: - description: "none" - $ref: "#/definitions/tapi.photonic.media.MediaChannelServiceInterfacePointSpec" - x-augmentation: - prefix: "tapi-photonic-media" - namespace: "urn:onf:otcc:yang:tapi-photonic-media" - tapi.photonic.media.ServiceInterfacePointAugmentation2: - type: "object" - properties: - otsi-service-interface-point-spec: - description: "none" - $ref: "#/definitions/tapi.photonic.media.OtsiServiceInterfacePointSpec" - x-augmentation: - prefix: "tapi-photonic-media" - namespace: "urn:onf:otcc:yang:tapi-photonic-media" - tapi.photonic.media.SipAugmentation1: - type: "object" - properties: - media-channel-service-interface-point-spec: - description: "none" - $ref: "#/definitions/tapi.photonic.media.MediaChannelServiceInterfacePointSpec" - x-augmentation: - prefix: "tapi-photonic-media" - namespace: "urn:onf:otcc:yang:tapi-photonic-media" - tapi.photonic.media.SipAugmentation2: - type: "object" - properties: - otsi-service-interface-point-spec: - description: "none" - $ref: "#/definitions/tapi.photonic.media.OtsiServiceInterfacePointSpec" - x-augmentation: - prefix: "tapi-photonic-media" - namespace: "urn:onf:otcc:yang:tapi-photonic-media" - tapi.photonic.media.SpectrumBand: - type: "object" - properties: - lower-frequency: - type: "integer" - format: "int32" - description: "The lower frequency bound of the media channel spectrum specified\ - \ in MHz" - upper-frequency: - type: "integer" - format: "int32" - description: "The upper frequency bound of the media channel spectrum specified\ - \ in MHz" - frequency-constraint: - description: "none" - $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" - tapi.photonic.media.TotalPowerThresholdPac: - type: "object" - properties: - total-power-upper-warn-threshold-default: - type: "string" - description: "Can read the value of the default threshold that was set" - total-power-lower-warn-threshold-min: - type: "string" - description: "Can read the value of the lower threshold that was set" - total-power-upper-warn-threshold-min: - type: "string" - description: "Can read the value of the lower threshold that was set" - total-power-upper-warn-threshold-max: - type: "string" - description: "Can read the value of the upper threshold that was set" - total-power-lower-warn-threshold-max: - type: "string" - description: "Can read the value of the upper threshold that was set" - total-power-lower-warn-threshold-default: - type: "string" - description: "Can read the value of the default threshold that was set" - tapi.topology.ContextAugmentation5: - type: "object" - properties: - topology-context: - description: "Augments the base TAPI Context with TopologyService information" - $ref: "#/definitions/tapi.topology.TopologyContext" - x-augmentation: - prefix: "tapi-topology" - namespace: "urn:onf:otcc:yang:tapi-topology" - tapi.topology.CostCharacteristic: - type: "object" - properties: - cost-value: - type: "string" - description: "The specific cost." - cost-algorithm: - type: "string" - description: "The cost may vary based upon some properties of the TopologicalEntity.\ - \ The rules for the variation are conveyed by the costAlgorithm." - cost-name: - type: "string" - description: "The cost characteristic will related to some aspect of the TopologicalEntity\ - \ (e.g. $ cost, routing weight). This aspect will be conveyed by the costName." - tapi.topology.ForwardingRule: - type: "string" - enum: - - "MAY_FORWARD_ACROSS_GROUP" - - "MUST_FORWARD_ACROSS_GROUP" - - "CANNOT_FORWARD_ACROSS_GROUP" - - "NO_STATEMENT_ON_FORWARDING" - tapi.topology.GetLinkDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.getlinkdetails.Output" - tapi.topology.GetNodeDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.getnodedetails.Output" - tapi.topology.GetNodeEdgePointDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Output" - tapi.topology.GetTopologyDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.gettopologydetails.Output" - tapi.topology.GetTopologyList: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.gettopologylist.Output" - tapi.topology.InterRuleGroup: - allOf: - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.RiskParameterPac" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - type: "object" - properties: - associated-node-rule-group: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - rule: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Rule" - description: "none" - tapi.topology.LatencyCharacteristic: - type: "object" - properties: - traffic-property-name: - type: "string" - description: "The identifier of the specific traffic property to which the\ - \ queuing latency applies." - jitter-characteristic: - type: "string" - description: "High frequency deviation from true periodicity of a signal and\ - \ therefore a small high rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." - fixed-latency-characteristic: - type: "string" - description: "A TopologicalEntity suffers delay caused by the realization\ - \ of the servers (e.g. distance related; FEC encoding etc.) along with some\ - \ client specific processing. This is the total average latency effect of\ - \ the TopologicalEntity" - wander-characteristic: - type: "string" - description: "Low frequency deviation from true periodicity of a signal and\ - \ therefore a small low rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." - queing-latency-characteristic: - type: "string" - description: "The specific queuing latency for the traffic property." - tapi.topology.LayerProtocolTransitionPac: - type: "object" - properties: - transitioned-layer-protocol-name: - type: "array" - description: "Provides the ordered structure of layer protocol transitions\ - \ encapsulated in the TopologicalEntity. The ordering relates to the LinkPort\ - \ role." - items: - type: "string" - tapi.topology.Link: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.LayerProtocolTransitionPac" - - $ref: "#/definitions/tapi.topology.RiskParameterPac" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - $ref: "#/definitions/tapi.topology.ValidationPac" - - type: "object" - properties: - layer-protocol-name: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - 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.NetworkTopologyService: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - description: "none" - tapi.topology.Node: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - type: "object" - properties: - layer-protocol-name: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - encap-topology: - description: "none" - $ref: "#/definitions/tapi.topology.TopologyRef" - 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.NodeRef: - allOf: - - $ref: "#/definitions/tapi.topology.TopologyRef" - - type: "object" - properties: - node-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:uuid" - description: "none" - tapi.topology.NodeRuleGroup: - allOf: - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.RiskParameterPac" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - type: "object" - properties: - inter-rule-group: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.InterRuleGroup" - rule: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Rule" - composed-rule-group: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - node-edge-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - description: "none" - tapi.topology.NodeRuleGroupRef: - allOf: - - $ref: "#/definitions/tapi.topology.NodeRef" - - type: "object" - properties: - node-rule-group-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-rule-group/tapi-topology:uuid" - description: "none" - tapi.topology.ProtectionType: - type: "string" - enum: - - "NO_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" - 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.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.RiskParameterPac: - type: "object" - properties: - risk-characteristic: - type: "array" - description: "A list of risk characteristics for consideration in an analysis\ - \ of shared risk. Each element of the list represents a specific risk consideration." - items: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - tapi.topology.Rule: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - override-priority: - type: "integer" - format: "int32" - description: "none" - forwarding-rule: - description: "none" - $ref: "#/definitions/tapi.topology.ForwardingRule" - rule-type: - description: "none" - $ref: "#/definitions/tapi.topology.RuleType" - description: "none" - tapi.topology.RuleType: - type: "string" - enum: - - "FORWARDING" - - "CAPACITY" - - "COST" - - "TIMING" - - "RISK" - - "GROUPING" - tapi.topology.Topology: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - layer-protocol-name: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - link: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Link" - node: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Node" - description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ - \ topological component which is used to effect forwarding of transport characteristic\ - \ information and offers the potential to enable forwarding. \r\n \ - \ At the lowest level of recursion, an FD (within a network element\ - \ (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ - \ multiple switch matrices (FDs). " - tapi.topology.TopologyContext: - type: "object" - properties: - nw-topology-service: - description: "none" - $ref: "#/definitions/tapi.topology.NetworkTopologyService" - topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Topology" - tapi.topology.TopologyRef: - type: "object" - properties: - topology-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:uuid" - tapi.topology.TransferCostPac: - type: "object" - properties: - cost-characteristic: - type: "array" - description: "The list of costs where each cost relates to some aspect of\ - \ the TopologicalEntity." - items: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - tapi.topology.TransferIntegrityPac: - type: "object" - properties: - error-characteristic: - type: "string" - description: "Describes the degree to which the signal propagated can be errored.\ - \ \r\n Applies to TDM systems as the errored signal will\ - \ be propagated and not packet as errored packets will be discarded." - unavailable-time-characteristic: - type: "string" - description: "Describes the duration for which there may be no valid signal\ - \ propagated." - server-integrity-process-characteristic: - type: "string" - description: "Describes the effect of any server integrity enhancement process\ - \ on the characteristics of the TopologicalEntity." - delivery-order-characteristic: - type: "string" - description: "Describes the degree to which packets will be delivered out\ - \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ - \ maintain strict order." - repeat-delivery-characteristic: - type: "string" - description: "Primarily applies to packet systems where a packet may be delivered\ - \ more than once (in fault recovery for example). \r\n \ - \ It can also apply to TDM where several frames may be received twice\ - \ due to switching in a system with a large differential propagation delay." - loss-characteristic: - type: "string" - description: "Describes the acceptable characteristic of lost packets where\ - \ loss may result from discard due to errors or overflow.\r\n \ - \ Applies to packet systems and not TDM (as for TDM errored signals\ - \ are propagated unless grossly errored and overflow/underflow turns into\ - \ timing slips)." - tapi.topology.TransferTimingPac: - type: "object" - properties: - latency-characteristic: - type: "array" - description: "The effect on the latency of a queuing process. This only has\ - \ significant effect for packet based systems and has a complex characteristic." - items: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - tapi.topology.ValidationMechanism: - type: "object" - properties: - layer-protocol-adjacency-validated: - type: "string" - description: "State of validatiion" - validation-mechanism: - type: "string" - description: "Name of mechanism used to validate adjacency" - validation-robustness: - type: "string" - description: "Quality of validation (i.e. how likely is the stated validation\ - \ to be invalid)" - tapi.topology.ValidationPac: - type: "object" - properties: - validation-mechanism: - type: "array" - description: "Provides details of the specific validation mechanism(s) used\ - \ to confirm the presence of an intended topologicalEntity." - items: - $ref: "#/definitions/tapi.topology.ValidationMechanism" - tapi.topology.getlinkdetails.Input: - type: "object" - properties: - link-id-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.getnodeedgepointdetails.output.NodeEdgePoint" - tapi.topology.getnodeedgepointdetails.output.NodeEdgePoint: - allOf: - - $ref: "#/definitions/tapi.photonic.media.NodeEdgePointAugmentation1" - - $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.OwnedNodeEdgePointAugmentation3" - - $ref: "#/definitions/tapi.odu.OwnedNodeEdgePointAugmentation1" - - $ref: "#/definitions/tapi.photonic.media.OwnedNodeEdgePointAugmentation2" - - $ref: "#/definitions/tapi.topology.NodeEdgePoint" - tapi.topology.topology.Node: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.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" diff --git a/OAS/tapi-topology@2018-12-10.yaml b/OAS/tapi-topology@2018-12-10.yaml deleted file mode 100644 index 83a270bb..00000000 --- a/OAS/tapi-topology@2018-12-10.yaml +++ /dev/null @@ -1,6401 +0,0 @@ ---- -swagger: "2.0" -info: - description: "tapi-notification,tapi-topology,tapi-common API generated from yang\ - \ definitions" - version: "1.0" - title: "tapi-notification,tapi-topology,tapi-common API" -host: "localhost:1234" -consumes: -- "application/yang-data+json" -produces: -- "application/yang-data+json" -paths: - /data/context/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Context" - parameters: [] - responses: - 200: - description: "tapi.common.Context" - schema: - $ref: "#/definitions/tapi.common.Context" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.Context" - parameters: - - in: "body" - name: "tapi.common.Context.body-param" - description: "tapi.common.Context to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.Context" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.Context" - parameters: - - in: "body" - name: "tapi.common.Context.body-param" - description: "tapi.common.Context to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.Context" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.Context" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationContext" - parameters: [] - responses: - 200: - description: "tapi.notification.NotificationContext" - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationContext" - parameters: - - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationContext" - parameters: - - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription/: - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" - parameters: - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NotificationSubscriptionService" - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NotificationChannel" - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.Notification" - schema: - $ref: "#/definitions/tapi.notification.Notification" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of additional-info" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of changed-attributes" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NameAndValueChange" - schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of target-object-name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/tca-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.SubscriptionFilter" - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notification={uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.Notification" - schema: - $ref: "#/definitions/tapi.notification.Notification" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/additional-info={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of additional-info" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of changed-attributes" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NameAndValueChange" - schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of target-object-name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/tca-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" - /data/context/service-interface-point/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePoint" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/available-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/total-potential-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyContext" - parameters: [] - responses: - 200: - description: "tapi.topology.TopologyContext" - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-topology" - description: "creates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-topology" - description: "creates or updates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-topology" - description: "removes tapi.topology.TopologyContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/topology-context/nw-topology-service/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NetworkTopologyService" - parameters: [] - responses: - 200: - description: "tapi.topology.NetworkTopologyService" - schema: - $ref: "#/definitions/tapi.topology.NetworkTopologyService" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "topology-uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Topology" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Topology" - schema: - $ref: "#/definitions/tapi.topology.Topology" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Link" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Link" - schema: - $ref: "#/definitions/tapi.topology.Link" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/resilience-type/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ValidationMechanism" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "validation-mechanism" - in: "path" - description: "Id of validation-mechanism" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ValidationMechanism" - schema: - $ref: "#/definitions/tapi.topology.ValidationMechanism" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Node" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Node" - schema: - $ref: "#/definitions/tapi.topology.Node" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroup" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroup" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-rule-group-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroupRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.InterRuleGroup" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.InterRuleGroup" - schema: - $ref: "#/definitions/tapi.topology.InterRuleGroup" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-rule-group-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroupRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Rule" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Rule" - schema: - $ref: "#/definitions/tapi.topology.Rule" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Rule" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Rule" - schema: - $ref: "#/definitions/tapi.topology.Rule" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePoint" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePoint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "service-interface-point-uuid" - in: "path" - description: "Id of mapped-service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /operations/create-notification-subscription-service/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.CreateNotificationSubscriptionService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/delete-notification-subscription-service/: - post: - tags: - - "tapi-notification" - 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/get-link-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.getlinkdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.getlinkdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetLinkDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-node-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.getnodedetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.getnodedetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetNodeDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-node-edge-point-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.getnodeedgepointdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetNodeEdgePointDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-list/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.getnotificationlist.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.getnotificationlist.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-subscription-service-details/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-subscription-service-list/: - post: - tags: - - "tapi-notification" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-service-interface-point-details/: - post: - tags: - - "tapi-common" - parameters: - - in: "body" - name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.common.GetServiceInterfacePointDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-service-interface-point-list/: - post: - tags: - - "tapi-common" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.common.GetServiceInterfacePointList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-supported-notification-types/: - post: - tags: - - "tapi-notification" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetSupportedNotificationTypes" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-topology-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.gettopologydetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.gettopologydetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetTopologyDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-topology-list/: - post: - tags: - - "tapi-topology" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetTopologyList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-notification-subscription-service/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.UpdateNotificationSubscriptionService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-service-interface-point/: - post: - tags: - - "tapi-common" - parameters: - - in: "body" - name: "tapi.common.updateserviceinterfacepoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.common.updateserviceinterfacepoint.Input" - responses: - 201: - description: "No response" - 400: - description: "Internal error" -definitions: - tapi.common.AdminStatePac: - type: "object" - properties: - operational-state: - description: "none" - $ref: "#/definitions/tapi.common.OperationalState" - lifecycle-state: - description: "none" - $ref: "#/definitions/tapi.common.LifecycleState" - administrative-state: - description: "none" - $ref: "#/definitions/tapi.common.AdministrativeState" - tapi.common.AdministrativeState: - type: "string" - enum: - - "LOCKED" - - "UNLOCKED" - tapi.common.BandwidthProfile: - type: "object" - properties: - committed-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - coupling-flag: - type: "boolean" - description: "none" - default: false - bw-profile-type: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfileType" - peak-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - committed-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - peak-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - color-aware: - type: "boolean" - description: "none" - default: false - tapi.common.BandwidthProfileType: - type: "string" - enum: - - "MEF_10.x" - - "RFC_2697" - - "RFC_2698" - - "RFC_4115" - tapi.common.Capacity: - type: "object" - properties: - bandwidth-profile: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfile" - total-size: - description: "Total capacity of the TopologicalEntity in MB/s. In case of\ - \ bandwidthProfile, this is expected to same as the committedInformationRate." - $ref: "#/definitions/tapi.common.CapacityValue" - tapi.common.CapacityPac: - type: "object" - properties: - available-capacity: - description: "Capacity available to be assigned." - $ref: "#/definitions/tapi.common.Capacity" - total-potential-capacity: - description: "An optimistic view of the capacity of the TopologicalEntity\ - \ assuming that any shared capacity is available to be taken." - $ref: "#/definitions/tapi.common.Capacity" - tapi.common.CapacityUnit: - type: "string" - enum: - - "TB" - - "TBPS" - - "GB" - - "GBPS" - - "MB" - - "MBPS" - - "KB" - - "KBPS" - - "GHz" - - "MHz" - tapi.common.CapacityValue: - type: "object" - properties: - value: - type: "integer" - format: "int32" - description: "none" - unit: - description: "none" - $ref: "#/definitions/tapi.common.CapacityUnit" - tapi.common.Context: - allOf: - - $ref: "#/definitions/tapi.common.TapiContext" - - $ref: "#/definitions/tapi.notification.ContextAugmentation1" - - $ref: "#/definitions/tapi.topology.ContextAugmentation2" - 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.OperationalState: - type: "string" - enum: - - "DISABLED" - - "ENABLED" - tapi.common.PortDirection: - type: "string" - enum: - - "BIDIRECTIONAL" - - "INPUT" - - "OUTPUT" - - "UNIDENTIFIED_OR_UNKNOWN" - tapi.common.PortRole: - type: "string" - enum: - - "SYMMETRIC" - - "ROOT" - - "LEAF" - - "TRUNK" - - "UNKNOWN" - tapi.common.ServiceInterfacePoint: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - supported-layer-protocol-qualifier: - type: "array" - description: "none" - items: - type: "string" - layer-protocol-name: - description: "Usage of layerProtocolName [>1] in the ServiceInterfacePoint\ - \ should be considered experimental" - $ref: "#/definitions/tapi.common.LayerProtocolName" - description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ - \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ - \ circuit and packet forms." - tapi.common.ServiceInterfacePointRef: - type: "object" - properties: - service-interface-point-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-common:service-interface-point/tapi-common:uuid" - tapi.common.TapiContext: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - service-interface-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - description: "The Network Control Domain (NCD) object class represents the scope\ - \ of control that a particular SDN controller has with respect to a particular\ - \ network, (i.e., encompassing a designated set of interconnected (virtual)\ - \ network elements)." - tapi.common.TerminationDirection: - type: "string" - enum: - - "BIDIRECTIONAL" - - "SINK" - - "SOURCE" - - "UNDEFINED_OR_UNKNOWN" - tapi.common.TerminationPac: - type: "object" - properties: - termination-direction: - description: "The overall directionality of the LP. \r\n \ - \ - A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ - \ - A SINK LP can only contain elements with SINK flows\ - \ or CONTRA_DIRECTION_SOURCE flows\r\n - A SOURCE LP\ - \ can only contain SOURCE flows or CONTRA_DIRECTION_SINK flows" - $ref: "#/definitions/tapi.common.TerminationDirection" - termination-state: - description: "Indicates whether the layer is terminated and if so how." - $ref: "#/definitions/tapi.common.TerminationState" - tapi.common.TerminationState: - type: "string" - enum: - - "LP_CAN_NEVER_TERMINATE" - - "LT_NOT_TERMINATED" - - "TERMINATED_SERVER_TO_CLIENT_FLOW" - - "TERMINATED_CLIENT_TO_SERVER_FLOW" - - "TERMINATED_BIDIRECTIONAL" - - "LT_PERMENANTLY_TERMINATED" - - "TERMINATION_STATE_UNKNOWN" - tapi.common.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.notification.AlarmInfo: - type: "object" - properties: - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedSeverityType" - probable-cause: - type: "string" - description: "none" - service-affecting: - description: "none" - $ref: "#/definitions/tapi.notification.ServiceAffecting" - is-transient: - type: "boolean" - description: "none" - default: false - tapi.notification.ContextAugmentation1: - type: "object" - properties: - notification-context: - description: "Augments the base TAPI Context with NotificationService information" - $ref: "#/definitions/tapi.notification.NotificationContext" - 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.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.NotificationContext: - type: "object" - properties: - notif-subscription: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - notification: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.Notification" - tapi.notification.NotificationSubscriptionService: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - notification: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.Notification" - notification-channel: - description: "none" - $ref: "#/definitions/tapi.notification.NotificationChannel" - subscription-state: - description: "none" - $ref: "#/definitions/tapi.notification.SubscriptionState" - supported-object-types: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.ObjectType" - supported-notification-types: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.NotificationType" - subscription-filter: - description: "none" - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - description: "none" - tapi.notification.NotificationType: - type: "string" - enum: - - "OBJECT_CREATION" - - "OBJECT_DELETION" - - "ATTRIBUTE_VALUE_CHANGE" - - "ALARM_EVENT" - - "THRESHOLD_CROSSING_ALERT" - tapi.notification.ObjectType: - type: "string" - enum: - - "TOPOLOGY" - - "NODE" - - "LINK" - - "CONNECTION" - - "PATH" - - "CONNECTIVITY_SERVICE" - - "VIRTUAL_NETWORK_SERVICE" - - "PATH_COMPUTATION_SERVICE" - - "NODE_EDGE_POINT" - - "SERVICE_INTERFACE_POINT" - - "CONNECTION_END_POINT" - - "MAINTENANCE_ENTITY_GROUP" - - "MAINTENANCE_ENTITY" - - "MEG_END_POINT" - - "MEG_INTERMEDIATE_POINT" - - "SWITCH_CONTROL" - - "SWITCH" - - "ROUTE" - - "NODE_RULE_GROUP" - - "INTER_RULE_GROUP" - - "RULE" - - "OAM_JOB" - tapi.notification.PerceivedSeverityType: - type: "string" - enum: - - "CRITICAL" - - "MAJOR" - - "MINOR" - - "WARNING" - - "CLEARED" - tapi.notification.PerceivedTcaSeverity: - type: "string" - enum: - - "WARNING" - - "CLEAR" - tapi.notification.ServiceAffecting: - type: "string" - enum: - - "SERVICE_AFFECTING" - - "NOT_SERVICE_AFFECTING" - - "UNKNOWN" - 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.SubscriptionState: - type: "string" - enum: - - "SUSPENDED" - - "ACTIVE" - tapi.notification.TcaInfo: - type: "object" - properties: - threshold-crossing: - description: "none" - $ref: "#/definitions/tapi.notification.ThresholdCrossingType" - threshold-parameter: - type: "string" - description: "none" - is-transient: - type: "boolean" - description: "none" - default: false - threshold-value: - type: "integer" - format: "int32" - description: "none" - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedTcaSeverity" - suspect-interval-flag: - type: "boolean" - description: "none" - default: false - measurement-interval: - type: "string" - description: "none" - tapi.notification.ThresholdCrossingType: - type: "string" - enum: - - "THRESHOLD_ABOVE" - - "THRESHOLD_BELOW" - - "CLEARED" - tapi.notification.UpdateNotificationSubscriptionService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Output" - tapi.notification.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.topology.ContextAugmentation2: - type: "object" - properties: - topology-context: - description: "Augments the base TAPI Context with TopologyService information" - $ref: "#/definitions/tapi.topology.TopologyContext" - x-augmentation: - prefix: "tapi-topology" - namespace: "urn:onf:otcc:yang:tapi-topology" - tapi.topology.CostCharacteristic: - type: "object" - properties: - cost-value: - type: "string" - description: "The specific cost." - cost-algorithm: - type: "string" - description: "The cost may vary based upon some properties of the TopologicalEntity.\ - \ The rules for the variation are conveyed by the costAlgorithm." - cost-name: - type: "string" - description: "The cost characteristic will related to some aspect of the TopologicalEntity\ - \ (e.g. $ cost, routing weight). This aspect will be conveyed by the costName." - tapi.topology.ForwardingRule: - type: "string" - enum: - - "MAY_FORWARD_ACROSS_GROUP" - - "MUST_FORWARD_ACROSS_GROUP" - - "CANNOT_FORWARD_ACROSS_GROUP" - - "NO_STATEMENT_ON_FORWARDING" - tapi.topology.GetLinkDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.getlinkdetails.Output" - tapi.topology.GetNodeDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.getnodedetails.Output" - tapi.topology.GetNodeEdgePointDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Output" - tapi.topology.GetTopologyDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.gettopologydetails.Output" - tapi.topology.GetTopologyList: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.gettopologylist.Output" - tapi.topology.InterRuleGroup: - allOf: - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.RiskParameterPac" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - type: "object" - properties: - associated-node-rule-group: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - rule: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Rule" - description: "none" - tapi.topology.LatencyCharacteristic: - type: "object" - properties: - traffic-property-name: - type: "string" - description: "The identifier of the specific traffic property to which the\ - \ queuing latency applies." - jitter-characteristic: - type: "string" - description: "High frequency deviation from true periodicity of a signal and\ - \ therefore a small high rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." - fixed-latency-characteristic: - type: "string" - description: "A TopologicalEntity suffers delay caused by the realization\ - \ of the servers (e.g. distance related; FEC encoding etc.) along with some\ - \ client specific processing. This is the total average latency effect of\ - \ the TopologicalEntity" - wander-characteristic: - type: "string" - description: "Low frequency deviation from true periodicity of a signal and\ - \ therefore a small low rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." - queing-latency-characteristic: - type: "string" - description: "The specific queuing latency for the traffic property." - tapi.topology.LayerProtocolTransitionPac: - type: "object" - properties: - transitioned-layer-protocol-name: - type: "array" - description: "Provides the ordered structure of layer protocol transitions\ - \ encapsulated in the TopologicalEntity. The ordering relates to the LinkPort\ - \ role." - items: - type: "string" - tapi.topology.Link: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.LayerProtocolTransitionPac" - - $ref: "#/definitions/tapi.topology.RiskParameterPac" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - $ref: "#/definitions/tapi.topology.ValidationPac" - - type: "object" - properties: - layer-protocol-name: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - 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.NetworkTopologyService: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - description: "none" - tapi.topology.Node: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - type: "object" - properties: - layer-protocol-name: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - encap-topology: - description: "none" - $ref: "#/definitions/tapi.topology.TopologyRef" - 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.NodeRef: - allOf: - - $ref: "#/definitions/tapi.topology.TopologyRef" - - type: "object" - properties: - node-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:uuid" - description: "none" - tapi.topology.NodeRuleGroup: - allOf: - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.RiskParameterPac" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - type: "object" - properties: - inter-rule-group: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.InterRuleGroup" - rule: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Rule" - composed-rule-group: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - node-edge-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - description: "none" - tapi.topology.NodeRuleGroupRef: - allOf: - - $ref: "#/definitions/tapi.topology.NodeRef" - - type: "object" - properties: - node-rule-group-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-rule-group/tapi-topology:uuid" - description: "none" - tapi.topology.ProtectionType: - type: "string" - enum: - - "NO_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" - 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.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.RiskParameterPac: - type: "object" - properties: - risk-characteristic: - type: "array" - description: "A list of risk characteristics for consideration in an analysis\ - \ of shared risk. Each element of the list represents a specific risk consideration." - items: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - tapi.topology.Rule: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - override-priority: - type: "integer" - format: "int32" - description: "none" - forwarding-rule: - description: "none" - $ref: "#/definitions/tapi.topology.ForwardingRule" - rule-type: - description: "none" - $ref: "#/definitions/tapi.topology.RuleType" - description: "none" - tapi.topology.RuleType: - type: "string" - enum: - - "FORWARDING" - - "CAPACITY" - - "COST" - - "TIMING" - - "RISK" - - "GROUPING" - tapi.topology.Topology: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - layer-protocol-name: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - link: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Link" - node: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Node" - description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ - \ topological component which is used to effect forwarding of transport characteristic\ - \ information and offers the potential to enable forwarding. \r\n \ - \ At the lowest level of recursion, an FD (within a network element\ - \ (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ - \ multiple switch matrices (FDs). " - tapi.topology.TopologyContext: - type: "object" - properties: - nw-topology-service: - description: "none" - $ref: "#/definitions/tapi.topology.NetworkTopologyService" - topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Topology" - tapi.topology.TopologyRef: - type: "object" - properties: - topology-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:uuid" - tapi.topology.TransferCostPac: - type: "object" - properties: - cost-characteristic: - type: "array" - description: "The list of costs where each cost relates to some aspect of\ - \ the TopologicalEntity." - items: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - tapi.topology.TransferIntegrityPac: - type: "object" - properties: - error-characteristic: - type: "string" - description: "Describes the degree to which the signal propagated can be errored.\ - \ \r\n Applies to TDM systems as the errored signal will\ - \ be propagated and not packet as errored packets will be discarded." - unavailable-time-characteristic: - type: "string" - description: "Describes the duration for which there may be no valid signal\ - \ propagated." - server-integrity-process-characteristic: - type: "string" - description: "Describes the effect of any server integrity enhancement process\ - \ on the characteristics of the TopologicalEntity." - delivery-order-characteristic: - type: "string" - description: "Describes the degree to which packets will be delivered out\ - \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ - \ maintain strict order." - repeat-delivery-characteristic: - type: "string" - description: "Primarily applies to packet systems where a packet may be delivered\ - \ more than once (in fault recovery for example). \r\n \ - \ It can also apply to TDM where several frames may be received twice\ - \ due to switching in a system with a large differential propagation delay." - loss-characteristic: - type: "string" - description: "Describes the acceptable characteristic of lost packets where\ - \ loss may result from discard due to errors or overflow.\r\n \ - \ Applies to packet systems and not TDM (as for TDM errored signals\ - \ are propagated unless grossly errored and overflow/underflow turns into\ - \ timing slips)." - tapi.topology.TransferTimingPac: - type: "object" - properties: - latency-characteristic: - type: "array" - description: "The effect on the latency of a queuing process. This only has\ - \ significant effect for packet based systems and has a complex characteristic." - items: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - tapi.topology.ValidationMechanism: - type: "object" - properties: - layer-protocol-adjacency-validated: - type: "string" - description: "State of validatiion" - validation-mechanism: - type: "string" - description: "Name of mechanism used to validate adjacency" - validation-robustness: - type: "string" - description: "Quality of validation (i.e. how likely is the stated validation\ - \ to be invalid)" - tapi.topology.ValidationPac: - type: "object" - properties: - validation-mechanism: - type: "array" - description: "Provides details of the specific validation mechanism(s) used\ - \ to confirm the presence of an intended topologicalEntity." - items: - $ref: "#/definitions/tapi.topology.ValidationMechanism" - tapi.topology.getlinkdetails.Input: - type: "object" - properties: - link-id-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" diff --git a/OAS/tapi-virtual-network@2018-12-10.yaml b/OAS/tapi-virtual-network@2018-12-10.yaml deleted file mode 100644 index d544647f..00000000 --- a/OAS/tapi-virtual-network@2018-12-10.yaml +++ /dev/null @@ -1,8692 +0,0 @@ ---- -swagger: "2.0" -info: - description: "tapi-notification,tapi-topology,tapi-common,tapi-virtual-network API\ - \ generated from yang definitions" - version: "1.0" - title: "tapi-notification,tapi-topology,tapi-common,tapi-virtual-network API" -host: "localhost:1234" -consumes: -- "application/yang-data+json" -produces: -- "application/yang-data+json" -paths: - /data/context/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Context" - parameters: [] - responses: - 200: - description: "tapi.common.Context" - schema: - $ref: "#/definitions/tapi.common.Context" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.Context" - parameters: - - in: "body" - name: "tapi.common.Context.body-param" - description: "tapi.common.Context to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.Context" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.Context" - parameters: - - in: "body" - name: "tapi.common.Context.body-param" - description: "tapi.common.Context to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.Context" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.Context" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationContext" - parameters: [] - responses: - 200: - description: "tapi.notification.NotificationContext" - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationContext" - parameters: - - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationContext" - parameters: - - in: "body" - name: "tapi.notification.NotificationContext.body-param" - description: "tapi.notification.NotificationContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription/: - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" - parameters: - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NotificationSubscriptionService" - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationSubscriptionService.body-param" - description: "tapi.notification.NotificationSubscriptionService to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationSubscriptionService" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NotificationChannel" - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.NotificationChannel.body-param" - description: "tapi.notification.NotificationChannel to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.NotificationChannel" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.NotificationChannel" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.Notification" - schema: - $ref: "#/definitions/tapi.notification.Notification" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of additional-info" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of changed-attributes" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NameAndValueChange" - schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of target-object-name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/tca-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "notification-uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.SubscriptionFilter" - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.notification.SubscriptionFilter.body-param" - description: "tapi.notification.SubscriptionFilter to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.notification.SubscriptionFilter" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-notification" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-notification" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-notification" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notif-subscription" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/notification-context/notification={uuid}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.Notification" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.Notification" - schema: - $ref: "#/definitions/tapi.notification.Notification" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/additional-info={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of additional-info" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/alarm-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.AlarmInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.AlarmInfo" - schema: - $ref: "#/definitions/tapi.notification.AlarmInfo" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.NameAndValueChange" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of changed-attributes" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.NameAndValueChange" - schema: - $ref: "#/definitions/tapi.notification.NameAndValueChange" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: - get: - tags: - - "tapi-notification" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of target-object-name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/notification-context/notification={uuid}/tca-info/: - get: - tags: - - "tapi-notification" - description: "returns tapi.notification.TcaInfo" - parameters: - - name: "uuid" - in: "path" - description: "Id of notification" - required: true - type: "string" - responses: - 200: - description: "tapi.notification.TcaInfo" - schema: - $ref: "#/definitions/tapi.notification.TcaInfo" - 400: - description: "Internal error" - /data/context/service-interface-point/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePoint" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.ServiceInterfacePoint.body-param" - description: "tapi.common.ServiceInterfacePoint to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.ServiceInterfacePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/available-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/name/: - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/service-interface-point={uuid}/name={value-name}/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-common" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-common" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-common" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/service-interface-point={uuid}/total-potential-capacity/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-common" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyContext" - parameters: [] - responses: - 200: - description: "tapi.topology.TopologyContext" - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-topology" - description: "creates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-topology" - description: "creates or updates tapi.topology.TopologyContext" - parameters: - - in: "body" - name: "tapi.topology.TopologyContext.body-param" - description: "tapi.topology.TopologyContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.TopologyContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-topology" - description: "removes tapi.topology.TopologyContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/topology-context/nw-topology-service/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NetworkTopologyService" - parameters: [] - responses: - 200: - description: "tapi.topology.NetworkTopologyService" - schema: - $ref: "#/definitions/tapi.topology.NetworkTopologyService" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "topology-uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Topology" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Topology" - schema: - $ref: "#/definitions/tapi.topology.Topology" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Link" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Link" - schema: - $ref: "#/definitions/tapi.topology.Link" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/resilience-type/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ResilienceType" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ResilienceType" - schema: - $ref: "#/definitions/tapi.topology.ResilienceType" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.ValidationMechanism" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "link-uuid" - in: "path" - description: "Id of link" - required: true - type: "string" - - name: "validation-mechanism" - in: "path" - description: "Id of validation-mechanism" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.ValidationMechanism" - schema: - $ref: "#/definitions/tapi.topology.ValidationMechanism" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Node" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Node" - schema: - $ref: "#/definitions/tapi.topology.Node" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/bandwidth-profile/peak-information-rate/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroup" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroup" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroup" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - - name: "composed-rule-group-node-rule-group-uuid" - in: "path" - description: "Id of composed-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroupRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.InterRuleGroup" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.InterRuleGroup" - schema: - $ref: "#/definitions/tapi.topology.InterRuleGroup" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeRuleGroupRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - - name: "associated-node-rule-group-node-rule-group-uuid" - in: "path" - description: "Id of associated-node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeRuleGroupRef" - schema: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Rule" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Rule" - schema: - $ref: "#/definitions/tapi.topology.Rule" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "inter-rule-group-uuid" - in: "path" - description: "Id of inter-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-node-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.RiskCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "risk-characteristic-name" - in: "path" - description: "Id of risk-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.RiskCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.Rule" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.Rule" - schema: - $ref: "#/definitions/tapi.topology.Rule" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of rule" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "node-rule-group-uuid" - in: "path" - description: "Id of node-rule-group" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/: - get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePoint" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePoint" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.topology.NodeEdgePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "topology-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "aggregated-node-edge-point-node-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - - name: "node-edge-point-uuid" - in: "path" - description: "Id of aggregated-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.NodeEdgePointRef" - schema: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/available-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "service-interface-point-uuid" - in: "path" - description: "Id of mapped-service-interface-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/name={value-name}/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/total-potential-capacity/total-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - - name: "owned-node-edge-point-uuid" - in: "path" - description: "Id of owned-node-edge-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-burst-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - ? /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: - get: - tags: - - "tapi-topology" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of topology" - required: true - type: "string" - - name: "node-uuid" - in: "path" - description: "Id of node" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - /data/context/virtual-network-context/: - get: - tags: - - "tapi-virtual-network" - description: "returns tapi.virtual.network.VirtualNetworkContext" - parameters: [] - responses: - 200: - description: "tapi.virtual.network.VirtualNetworkContext" - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkContext" - 400: - description: "Internal error" - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.virtual.network.VirtualNetworkContext" - parameters: - - in: "body" - name: "tapi.virtual.network.VirtualNetworkContext.body-param" - description: "tapi.virtual.network.VirtualNetworkContext to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-virtual-network" - description: "creates or updates tapi.virtual.network.VirtualNetworkContext" - parameters: - - in: "body" - name: "tapi.virtual.network.VirtualNetworkContext.body-param" - description: "tapi.virtual.network.VirtualNetworkContext to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkContext" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-virtual-network" - description: "removes tapi.virtual.network.VirtualNetworkContext" - parameters: [] - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/virtual-network-context/virtual-nw-service/: - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.virtual.network.VirtualNetworkService" - parameters: - - in: "body" - name: "tapi.virtual.network.VirtualNetworkService.body-param" - description: "tapi.virtual.network.VirtualNetworkService to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/virtual-network-context/virtual-nw-service={uuid}/: - get: - tags: - - "tapi-virtual-network" - description: "returns tapi.virtual.network.VirtualNetworkService" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - responses: - 200: - description: "tapi.virtual.network.VirtualNetworkService" - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkService" - 400: - description: "Internal error" - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.virtual.network.VirtualNetworkService" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - in: "body" - name: "tapi.virtual.network.VirtualNetworkService.body-param" - description: "tapi.virtual.network.VirtualNetworkService to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-virtual-network" - description: "creates or updates tapi.virtual.network.VirtualNetworkService" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - in: "body" - name: "tapi.virtual.network.VirtualNetworkService.body-param" - description: "tapi.virtual.network.VirtualNetworkService to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkService" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-virtual-network" - description: "removes tapi.virtual.network.VirtualNetworkService" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/virtual-network-context/virtual-nw-service={uuid}/end-point/: - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.virtual.network.VirtualNetworkServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - in: "body" - name: "tapi.virtual.network.VirtualNetworkServiceEndPoint.body-param" - description: "tapi.virtual.network.VirtualNetworkServiceEndPoint to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/virtual-network-context/virtual-nw-service={uuid}/end-point={local-id}/: - get: - tags: - - "tapi-virtual-network" - description: "returns tapi.virtual.network.VirtualNetworkServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.virtual.network.VirtualNetworkServiceEndPoint" - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkServiceEndPoint" - 400: - description: "Internal error" - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.virtual.network.VirtualNetworkServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.virtual.network.VirtualNetworkServiceEndPoint.body-param" - description: "tapi.virtual.network.VirtualNetworkServiceEndPoint to be added\ - \ to list" - required: false - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-virtual-network" - description: "creates or updates tapi.virtual.network.VirtualNetworkServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.virtual.network.VirtualNetworkServiceEndPoint.body-param" - description: "tapi.virtual.network.VirtualNetworkServiceEndPoint to be added\ - \ or updated" - required: false - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkServiceEndPoint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-virtual-network" - description: "removes tapi.virtual.network.VirtualNetworkServiceEndPoint" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/virtual-network-context/virtual-nw-service={uuid}/end-point={local-id}/name/: - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/virtual-network-context/virtual-nw-service={uuid}/end-point={local-id}/name={value-name}/: - get: - tags: - - "tapi-virtual-network" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-virtual-network" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-virtual-network" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/virtual-network-context/virtual-nw-service={uuid}/end-point={local-id}/service-interface-point/: - get: - tags: - - "tapi-virtual-network" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of end-point" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - /data/context/virtual-network-context/virtual-nw-service={uuid}/name/: - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/virtual-network-context/virtual-nw-service={uuid}/name={value-name}/: - get: - tags: - - "tapi-virtual-network" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-virtual-network" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-virtual-network" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/virtual-network-context/virtual-nw-service={uuid}/state/: - get: - tags: - - "tapi-virtual-network" - description: "returns tapi.common.AdminStatePac" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - responses: - 200: - description: "tapi.common.AdminStatePac" - schema: - $ref: "#/definitions/tapi.common.AdminStatePac" - 400: - description: "Internal error" - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.common.AdminStatePac" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.AdminStatePac.body-param" - description: "tapi.common.AdminStatePac to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.AdminStatePac" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-virtual-network" - description: "creates or updates tapi.common.AdminStatePac" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - in: "body" - name: "tapi.common.AdminStatePac.body-param" - description: "tapi.common.AdminStatePac to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.AdminStatePac" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-virtual-network" - description: "removes tapi.common.AdminStatePac" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/virtual-network-context/virtual-nw-service={uuid}/topology/: - get: - tags: - - "tapi-virtual-network" - description: "returns tapi.topology.TopologyRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.TopologyRef" - schema: - $ref: "#/definitions/tapi.topology.TopologyRef" - 400: - description: "Internal error" - /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint/: - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.virtual.network.VirtualNetworkConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - in: "body" - name: "tapi.virtual.network.VirtualNetworkConstraint.body-param" - description: "tapi.virtual.network.VirtualNetworkConstraint to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/: - get: - tags: - - "tapi-virtual-network" - description: "returns tapi.virtual.network.VirtualNetworkConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - responses: - 200: - description: "tapi.virtual.network.VirtualNetworkConstraint" - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkConstraint" - 400: - description: "Internal error" - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.virtual.network.VirtualNetworkConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - in: "body" - name: "tapi.virtual.network.VirtualNetworkConstraint.body-param" - description: "tapi.virtual.network.VirtualNetworkConstraint to be added to\ - \ list" - required: false - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-virtual-network" - description: "creates or updates tapi.virtual.network.VirtualNetworkConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - in: "body" - name: "tapi.virtual.network.VirtualNetworkConstraint.body-param" - description: "tapi.virtual.network.VirtualNetworkConstraint to be added or\ - \ updated" - required: false - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkConstraint" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-virtual-network" - description: "removes tapi.virtual.network.VirtualNetworkConstraint" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/cost-characteristic/: - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/cost-characteristic={cost-name}/: - get: - tags: - - "tapi-virtual-network" - description: "returns tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.CostCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-virtual-network" - description: "creates or updates tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.CostCharacteristic.body-param" - description: "tapi.topology.CostCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-virtual-network" - description: "removes tapi.topology.CostCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - name: "cost-name" - in: "path" - description: "Id of cost-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/diversity-exclusion={virtual-nw-service-uuid}/ - : get: - tags: - - "tapi-virtual-network" - description: "returns tapi.virtual.network.VirtualNwServiceRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - name: "virtual-nw-service-uuid" - in: "path" - description: "Id of diversity-exclusion" - required: true - type: "string" - responses: - 200: - description: "tapi.virtual.network.VirtualNwServiceRef" - schema: - $ref: "#/definitions/tapi.virtual.network.VirtualNwServiceRef" - 400: - description: "Internal error" - /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/latency-characteristic/: - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - ? /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/latency-characteristic={traffic-property-name}/ - : get: - tags: - - "tapi-virtual-network" - description: "returns tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 200: - description: "tapi.topology.LatencyCharacteristic" - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - 400: - description: "Internal error" - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-virtual-network" - description: "creates or updates tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - - in: "body" - name: "tapi.topology.LatencyCharacteristic.body-param" - description: "tapi.topology.LatencyCharacteristic to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-virtual-network" - description: "removes tapi.topology.LatencyCharacteristic" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - name: "traffic-property-name" - in: "path" - description: "Id of latency-characteristic" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/name/: - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/name={value-name}/: - get: - tags: - - "tapi-virtual-network" - description: "returns tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 200: - description: "tapi.common.NameAndValue" - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-virtual-network" - description: "creates or updates tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - - in: "body" - name: "tapi.common.NameAndValue.body-param" - description: "tapi.common.NameAndValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.NameAndValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-virtual-network" - description: "removes tapi.common.NameAndValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - name: "value-name" - in: "path" - description: "Id of name" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/requested-capacity/: - get: - tags: - - "tapi-virtual-network" - description: "returns tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - responses: - 200: - description: "tapi.common.Capacity" - schema: - $ref: "#/definitions/tapi.common.Capacity" - 400: - description: "Internal error" - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-virtual-network" - description: "creates or updates tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - in: "body" - name: "tapi.common.Capacity.body-param" - description: "tapi.common.Capacity to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.Capacity" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-virtual-network" - description: "removes tapi.common.Capacity" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/requested-capacity/bandwidth-profile/: - get: - tags: - - "tapi-virtual-network" - description: "returns tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - responses: - 200: - description: "tapi.common.BandwidthProfile" - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - 400: - description: "Internal error" - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-virtual-network" - description: "creates or updates tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - in: "body" - name: "tapi.common.BandwidthProfile.body-param" - description: "tapi.common.BandwidthProfile to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.BandwidthProfile" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-virtual-network" - description: "removes tapi.common.BandwidthProfile" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/requested-capacity/bandwidth-profile/committed-burst-size/ - : get: - tags: - - "tapi-virtual-network" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-virtual-network" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-virtual-network" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/requested-capacity/bandwidth-profile/committed-information-rate/ - : get: - tags: - - "tapi-virtual-network" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-virtual-network" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-virtual-network" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/requested-capacity/bandwidth-profile/peak-burst-size/ - : get: - tags: - - "tapi-virtual-network" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-virtual-network" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-virtual-network" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - ? /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/requested-capacity/bandwidth-profile/peak-information-rate/ - : get: - tags: - - "tapi-virtual-network" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-virtual-network" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-virtual-network" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/requested-capacity/total-size/: - get: - tags: - - "tapi-virtual-network" - description: "returns tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - responses: - 200: - description: "tapi.common.CapacityValue" - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - 400: - description: "Internal error" - post: - tags: - - "tapi-virtual-network" - description: "creates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added to list" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 409: - description: "Object already exists" - put: - tags: - - "tapi-virtual-network" - description: "creates or updates tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - - in: "body" - name: "tapi.common.CapacityValue.body-param" - description: "tapi.common.CapacityValue to be added or updated" - required: false - schema: - $ref: "#/definitions/tapi.common.CapacityValue" - responses: - 201: - description: "Object created" - 400: - description: "Internal error" - 204: - description: "Object modified" - delete: - tags: - - "tapi-virtual-network" - description: "removes tapi.common.CapacityValue" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - responses: - 400: - description: "Internal error" - 204: - description: "Object deleted" - /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/sink-service-end-point/: - get: - tags: - - "tapi-virtual-network" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/src-service-end-point/: - get: - tags: - - "tapi-virtual-network" - description: "returns tapi.common.ServiceInterfacePointRef" - parameters: - - name: "uuid" - in: "path" - description: "Id of virtual-nw-service" - required: true - type: "string" - - name: "local-id" - in: "path" - description: "Id of vnw-constraint" - required: true - type: "string" - responses: - 200: - description: "tapi.common.ServiceInterfacePointRef" - schema: - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 400: - description: "Internal error" - /operations/create-notification-subscription-service/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.CreateNotificationSubscriptionService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/create-virtual-network-service/: - post: - tags: - - "tapi-virtual-network" - parameters: - - in: "body" - name: "tapi.virtual.network.createvirtualnetworkservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.virtual.network.createvirtualnetworkservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.virtual.network.CreateVirtualNetworkService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/delete-notification-subscription-service/: - post: - tags: - - "tapi-notification" - 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/delete-virtual-network-service/: - post: - tags: - - "tapi-virtual-network" - parameters: - - in: "body" - name: "tapi.virtual.network.deletevirtualnetworkservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.virtual.network.deletevirtualnetworkservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.virtual.network.DeleteVirtualNetworkService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-link-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.getlinkdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.getlinkdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetLinkDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-node-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.getnodedetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.getnodedetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetNodeDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-node-edge-point-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.getnodeedgepointdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetNodeEdgePointDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-list/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.getnotificationlist.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.getnotificationlist.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-subscription-service-details/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-notification-subscription-service-list/: - post: - tags: - - "tapi-notification" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-service-interface-point-details/: - post: - tags: - - "tapi-common" - parameters: - - in: "body" - name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.common.GetServiceInterfacePointDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-service-interface-point-list/: - post: - tags: - - "tapi-common" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.common.GetServiceInterfacePointList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-supported-notification-types/: - post: - tags: - - "tapi-notification" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.GetSupportedNotificationTypes" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-topology-details/: - post: - tags: - - "tapi-topology" - parameters: - - in: "body" - name: "tapi.topology.gettopologydetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.topology.gettopologydetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetTopologyDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-topology-list/: - post: - tags: - - "tapi-topology" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.topology.GetTopologyList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-virtual-network-service-details/: - post: - tags: - - "tapi-virtual-network" - parameters: - - in: "body" - name: "tapi.virtual.network.getvirtualnetworkservicedetails.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.virtual.network.getvirtualnetworkservicedetails.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.virtual.network.GetVirtualNetworkServiceDetails" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/get-virtual-network-service-list/: - post: - tags: - - "tapi-virtual-network" - parameters: [] - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.virtual.network.GetVirtualNetworkServiceList" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-notification-subscription-service/: - post: - tags: - - "tapi-notification" - parameters: - - in: "body" - name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Input" - responses: - 200: - description: "Correct response" - schema: - $ref: "#/definitions/tapi.notification.UpdateNotificationSubscriptionService" - 201: - description: "No response" - 400: - description: "Internal error" - /operations/update-service-interface-point/: - post: - tags: - - "tapi-common" - parameters: - - in: "body" - name: "tapi.common.updateserviceinterfacepoint.Input.body-param" - required: false - schema: - properties: - input: - $ref: "#/definitions/tapi.common.updateserviceinterfacepoint.Input" - responses: - 201: - description: "No response" - 400: - description: "Internal error" -definitions: - tapi.common.AdminStatePac: - type: "object" - properties: - operational-state: - description: "none" - $ref: "#/definitions/tapi.common.OperationalState" - lifecycle-state: - description: "none" - $ref: "#/definitions/tapi.common.LifecycleState" - administrative-state: - description: "none" - $ref: "#/definitions/tapi.common.AdministrativeState" - tapi.common.AdministrativeState: - type: "string" - enum: - - "LOCKED" - - "UNLOCKED" - tapi.common.BandwidthProfile: - type: "object" - properties: - committed-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - coupling-flag: - type: "boolean" - description: "none" - default: false - bw-profile-type: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfileType" - peak-information-rate: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - committed-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - peak-burst-size: - description: "none" - $ref: "#/definitions/tapi.common.CapacityValue" - color-aware: - type: "boolean" - description: "none" - default: false - tapi.common.BandwidthProfileType: - type: "string" - enum: - - "MEF_10.x" - - "RFC_2697" - - "RFC_2698" - - "RFC_4115" - tapi.common.Capacity: - type: "object" - properties: - bandwidth-profile: - description: "none" - $ref: "#/definitions/tapi.common.BandwidthProfile" - total-size: - description: "Total capacity of the TopologicalEntity in MB/s. In case of\ - \ bandwidthProfile, this is expected to same as the committedInformationRate." - $ref: "#/definitions/tapi.common.CapacityValue" - tapi.common.CapacityPac: - type: "object" - properties: - available-capacity: - description: "Capacity available to be assigned." - $ref: "#/definitions/tapi.common.Capacity" - total-potential-capacity: - description: "An optimistic view of the capacity of the TopologicalEntity\ - \ assuming that any shared capacity is available to be taken." - $ref: "#/definitions/tapi.common.Capacity" - tapi.common.CapacityUnit: - type: "string" - enum: - - "TB" - - "TBPS" - - "GB" - - "GBPS" - - "MB" - - "MBPS" - - "KB" - - "KBPS" - - "GHz" - - "MHz" - tapi.common.CapacityValue: - type: "object" - properties: - value: - type: "integer" - format: "int32" - description: "none" - unit: - description: "none" - $ref: "#/definitions/tapi.common.CapacityUnit" - tapi.common.Context: - allOf: - - $ref: "#/definitions/tapi.common.TapiContext" - - $ref: "#/definitions/tapi.notification.ContextAugmentation1" - - $ref: "#/definitions/tapi.topology.ContextAugmentation3" - - $ref: "#/definitions/tapi.virtual.network.ContextAugmentation2" - 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.OperationalState: - type: "string" - enum: - - "DISABLED" - - "ENABLED" - tapi.common.PortDirection: - type: "string" - enum: - - "BIDIRECTIONAL" - - "INPUT" - - "OUTPUT" - - "UNIDENTIFIED_OR_UNKNOWN" - tapi.common.PortRole: - type: "string" - enum: - - "SYMMETRIC" - - "ROOT" - - "LEAF" - - "TRUNK" - - "UNKNOWN" - tapi.common.ServiceInterfacePoint: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - supported-layer-protocol-qualifier: - type: "array" - description: "none" - items: - type: "string" - layer-protocol-name: - description: "Usage of layerProtocolName [>1] in the ServiceInterfacePoint\ - \ should be considered experimental" - $ref: "#/definitions/tapi.common.LayerProtocolName" - description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ - \ termination and adaptation functions of one or more transport layers. \r\ - \n The structure of LTP supports all transport protocols including\ - \ circuit and packet forms." - tapi.common.ServiceInterfacePointRef: - type: "object" - properties: - service-interface-point-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-common:service-interface-point/tapi-common:uuid" - tapi.common.TapiContext: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - service-interface-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" - description: "The Network Control Domain (NCD) object class represents the scope\ - \ of control that a particular SDN controller has with respect to a particular\ - \ network, (i.e., encompassing a designated set of interconnected (virtual)\ - \ network elements)." - tapi.common.TerminationDirection: - type: "string" - enum: - - "BIDIRECTIONAL" - - "SINK" - - "SOURCE" - - "UNDEFINED_OR_UNKNOWN" - tapi.common.TerminationPac: - type: "object" - properties: - termination-direction: - description: "The overall directionality of the LP. \r\n \ - \ - A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ - \ - A SINK LP can only contain elements with SINK flows\ - \ or CONTRA_DIRECTION_SOURCE flows\r\n - A SOURCE LP\ - \ can only contain SOURCE flows or CONTRA_DIRECTION_SINK flows" - $ref: "#/definitions/tapi.common.TerminationDirection" - termination-state: - description: "Indicates whether the layer is terminated and if so how." - $ref: "#/definitions/tapi.common.TerminationState" - tapi.common.TerminationState: - type: "string" - enum: - - "LP_CAN_NEVER_TERMINATE" - - "LT_NOT_TERMINATED" - - "TERMINATED_SERVER_TO_CLIENT_FLOW" - - "TERMINATED_CLIENT_TO_SERVER_FLOW" - - "TERMINATED_BIDIRECTIONAL" - - "LT_PERMENANTLY_TERMINATED" - - "TERMINATION_STATE_UNKNOWN" - tapi.common.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.notification.AlarmInfo: - type: "object" - properties: - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedSeverityType" - probable-cause: - type: "string" - description: "none" - service-affecting: - description: "none" - $ref: "#/definitions/tapi.notification.ServiceAffecting" - is-transient: - type: "boolean" - description: "none" - default: false - tapi.notification.ContextAugmentation1: - type: "object" - properties: - notification-context: - description: "Augments the base TAPI Context with NotificationService information" - $ref: "#/definitions/tapi.notification.NotificationContext" - 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.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.NotificationContext: - type: "object" - properties: - notif-subscription: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" - notification: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.Notification" - tapi.notification.NotificationSubscriptionService: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - notification: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.Notification" - notification-channel: - description: "none" - $ref: "#/definitions/tapi.notification.NotificationChannel" - subscription-state: - description: "none" - $ref: "#/definitions/tapi.notification.SubscriptionState" - supported-object-types: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.ObjectType" - supported-notification-types: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.notification.NotificationType" - subscription-filter: - description: "none" - $ref: "#/definitions/tapi.notification.SubscriptionFilter" - description: "none" - tapi.notification.NotificationType: - type: "string" - enum: - - "OBJECT_CREATION" - - "OBJECT_DELETION" - - "ATTRIBUTE_VALUE_CHANGE" - - "ALARM_EVENT" - - "THRESHOLD_CROSSING_ALERT" - tapi.notification.ObjectType: - type: "string" - enum: - - "TOPOLOGY" - - "NODE" - - "LINK" - - "CONNECTION" - - "PATH" - - "CONNECTIVITY_SERVICE" - - "VIRTUAL_NETWORK_SERVICE" - - "PATH_COMPUTATION_SERVICE" - - "NODE_EDGE_POINT" - - "SERVICE_INTERFACE_POINT" - - "CONNECTION_END_POINT" - - "MAINTENANCE_ENTITY_GROUP" - - "MAINTENANCE_ENTITY" - - "MEG_END_POINT" - - "MEG_INTERMEDIATE_POINT" - - "SWITCH_CONTROL" - - "SWITCH" - - "ROUTE" - - "NODE_RULE_GROUP" - - "INTER_RULE_GROUP" - - "RULE" - - "OAM_JOB" - tapi.notification.PerceivedSeverityType: - type: "string" - enum: - - "CRITICAL" - - "MAJOR" - - "MINOR" - - "WARNING" - - "CLEARED" - tapi.notification.PerceivedTcaSeverity: - type: "string" - enum: - - "WARNING" - - "CLEAR" - tapi.notification.ServiceAffecting: - type: "string" - enum: - - "SERVICE_AFFECTING" - - "NOT_SERVICE_AFFECTING" - - "UNKNOWN" - 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.SubscriptionState: - type: "string" - enum: - - "SUSPENDED" - - "ACTIVE" - tapi.notification.TcaInfo: - type: "object" - properties: - threshold-crossing: - description: "none" - $ref: "#/definitions/tapi.notification.ThresholdCrossingType" - threshold-parameter: - type: "string" - description: "none" - is-transient: - type: "boolean" - description: "none" - default: false - threshold-value: - type: "integer" - format: "int32" - description: "none" - perceived-severity: - description: "none" - $ref: "#/definitions/tapi.notification.PerceivedTcaSeverity" - suspect-interval-flag: - type: "boolean" - description: "none" - default: false - measurement-interval: - type: "string" - description: "none" - tapi.notification.ThresholdCrossingType: - type: "string" - enum: - - "THRESHOLD_ABOVE" - - "THRESHOLD_BELOW" - - "CLEARED" - tapi.notification.UpdateNotificationSubscriptionService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Output" - tapi.notification.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.topology.ContextAugmentation3: - type: "object" - properties: - topology-context: - description: "Augments the base TAPI Context with TopologyService information" - $ref: "#/definitions/tapi.topology.TopologyContext" - x-augmentation: - prefix: "tapi-topology" - namespace: "urn:onf:otcc:yang:tapi-topology" - tapi.topology.CostCharacteristic: - type: "object" - properties: - cost-value: - type: "string" - description: "The specific cost." - cost-algorithm: - type: "string" - description: "The cost may vary based upon some properties of the TopologicalEntity.\ - \ The rules for the variation are conveyed by the costAlgorithm." - cost-name: - type: "string" - description: "The cost characteristic will related to some aspect of the TopologicalEntity\ - \ (e.g. $ cost, routing weight). This aspect will be conveyed by the costName." - tapi.topology.ForwardingRule: - type: "string" - enum: - - "MAY_FORWARD_ACROSS_GROUP" - - "MUST_FORWARD_ACROSS_GROUP" - - "CANNOT_FORWARD_ACROSS_GROUP" - - "NO_STATEMENT_ON_FORWARDING" - tapi.topology.GetLinkDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.getlinkdetails.Output" - tapi.topology.GetNodeDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.getnodedetails.Output" - tapi.topology.GetNodeEdgePointDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Output" - tapi.topology.GetTopologyDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.gettopologydetails.Output" - tapi.topology.GetTopologyList: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.topology.gettopologylist.Output" - tapi.topology.InterRuleGroup: - allOf: - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.RiskParameterPac" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - type: "object" - properties: - associated-node-rule-group: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - rule: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Rule" - description: "none" - tapi.topology.LatencyCharacteristic: - type: "object" - properties: - traffic-property-name: - type: "string" - description: "The identifier of the specific traffic property to which the\ - \ queuing latency applies." - jitter-characteristic: - type: "string" - description: "High frequency deviation from true periodicity of a signal and\ - \ therefore a small high rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." - fixed-latency-characteristic: - type: "string" - description: "A TopologicalEntity suffers delay caused by the realization\ - \ of the servers (e.g. distance related; FEC encoding etc.) along with some\ - \ client specific processing. This is the total average latency effect of\ - \ the TopologicalEntity" - wander-characteristic: - type: "string" - description: "Low frequency deviation from true periodicity of a signal and\ - \ therefore a small low rate of change of transfer latency.\r\n \ - \ Applies to TDM systems (and not packet)." - queing-latency-characteristic: - type: "string" - description: "The specific queuing latency for the traffic property." - tapi.topology.LayerProtocolTransitionPac: - type: "object" - properties: - transitioned-layer-protocol-name: - type: "array" - description: "Provides the ordered structure of layer protocol transitions\ - \ encapsulated in the TopologicalEntity. The ordering relates to the LinkPort\ - \ role." - items: - type: "string" - tapi.topology.Link: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.LayerProtocolTransitionPac" - - $ref: "#/definitions/tapi.topology.RiskParameterPac" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - $ref: "#/definitions/tapi.topology.ValidationPac" - - type: "object" - properties: - layer-protocol-name: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - 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.NetworkTopologyService: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.TopologyRef" - description: "none" - tapi.topology.Node: - allOf: - - $ref: "#/definitions/tapi.common.AdminStatePac" - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - type: "object" - properties: - layer-protocol-name: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - encap-topology: - description: "none" - $ref: "#/definitions/tapi.topology.TopologyRef" - 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.NodeRef: - allOf: - - $ref: "#/definitions/tapi.topology.TopologyRef" - - type: "object" - properties: - node-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:uuid" - description: "none" - tapi.topology.NodeRuleGroup: - allOf: - - $ref: "#/definitions/tapi.common.CapacityPac" - - $ref: "#/definitions/tapi.common.GlobalClass" - - $ref: "#/definitions/tapi.topology.RiskParameterPac" - - $ref: "#/definitions/tapi.topology.TransferCostPac" - - $ref: "#/definitions/tapi.topology.TransferTimingPac" - - type: "object" - properties: - inter-rule-group: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.InterRuleGroup" - rule: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Rule" - composed-rule-group: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" - node-edge-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.NodeEdgePointRef" - description: "none" - tapi.topology.NodeRuleGroupRef: - allOf: - - $ref: "#/definitions/tapi.topology.NodeRef" - - type: "object" - properties: - node-rule-group-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-rule-group/tapi-topology:uuid" - description: "none" - tapi.topology.ProtectionType: - type: "string" - enum: - - "NO_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" - 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.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.RiskParameterPac: - type: "object" - properties: - risk-characteristic: - type: "array" - description: "A list of risk characteristics for consideration in an analysis\ - \ of shared risk. Each element of the list represents a specific risk consideration." - items: - $ref: "#/definitions/tapi.topology.RiskCharacteristic" - tapi.topology.Rule: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - override-priority: - type: "integer" - format: "int32" - description: "none" - forwarding-rule: - description: "none" - $ref: "#/definitions/tapi.topology.ForwardingRule" - rule-type: - description: "none" - $ref: "#/definitions/tapi.topology.RuleType" - description: "none" - tapi.topology.RuleType: - type: "string" - enum: - - "FORWARDING" - - "CAPACITY" - - "COST" - - "TIMING" - - "RISK" - - "GROUPING" - tapi.topology.Topology: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - layer-protocol-name: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - link: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Link" - node: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Node" - description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ - \ topological component which is used to effect forwarding of transport characteristic\ - \ information and offers the potential to enable forwarding. \r\n \ - \ At the lowest level of recursion, an FD (within a network element\ - \ (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ - \ multiple switch matrices (FDs). " - tapi.topology.TopologyContext: - type: "object" - properties: - nw-topology-service: - description: "none" - $ref: "#/definitions/tapi.topology.NetworkTopologyService" - topology: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.topology.Topology" - tapi.topology.TopologyRef: - type: "object" - properties: - topology-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:uuid" - tapi.topology.TransferCostPac: - type: "object" - properties: - cost-characteristic: - type: "array" - description: "The list of costs where each cost relates to some aspect of\ - \ the TopologicalEntity." - items: - $ref: "#/definitions/tapi.topology.CostCharacteristic" - tapi.topology.TransferIntegrityPac: - type: "object" - properties: - error-characteristic: - type: "string" - description: "Describes the degree to which the signal propagated can be errored.\ - \ \r\n Applies to TDM systems as the errored signal will\ - \ be propagated and not packet as errored packets will be discarded." - unavailable-time-characteristic: - type: "string" - description: "Describes the duration for which there may be no valid signal\ - \ propagated." - server-integrity-process-characteristic: - type: "string" - description: "Describes the effect of any server integrity enhancement process\ - \ on the characteristics of the TopologicalEntity." - delivery-order-characteristic: - type: "string" - description: "Describes the degree to which packets will be delivered out\ - \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ - \ maintain strict order." - repeat-delivery-characteristic: - type: "string" - description: "Primarily applies to packet systems where a packet may be delivered\ - \ more than once (in fault recovery for example). \r\n \ - \ It can also apply to TDM where several frames may be received twice\ - \ due to switching in a system with a large differential propagation delay." - loss-characteristic: - type: "string" - description: "Describes the acceptable characteristic of lost packets where\ - \ loss may result from discard due to errors or overflow.\r\n \ - \ Applies to packet systems and not TDM (as for TDM errored signals\ - \ are propagated unless grossly errored and overflow/underflow turns into\ - \ timing slips)." - tapi.topology.TransferTimingPac: - type: "object" - properties: - latency-characteristic: - type: "array" - description: "The effect on the latency of a queuing process. This only has\ - \ significant effect for packet based systems and has a complex characteristic." - items: - $ref: "#/definitions/tapi.topology.LatencyCharacteristic" - tapi.topology.ValidationMechanism: - type: "object" - properties: - layer-protocol-adjacency-validated: - type: "string" - description: "State of validatiion" - validation-mechanism: - type: "string" - description: "Name of mechanism used to validate adjacency" - validation-robustness: - type: "string" - description: "Quality of validation (i.e. how likely is the stated validation\ - \ to be invalid)" - tapi.topology.ValidationPac: - type: "object" - properties: - validation-mechanism: - type: "array" - description: "Provides details of the specific validation mechanism(s) used\ - \ to confirm the presence of an intended topologicalEntity." - items: - $ref: "#/definitions/tapi.topology.ValidationMechanism" - tapi.topology.getlinkdetails.Input: - type: "object" - properties: - link-id-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.virtual.network.ContextAugmentation2: - type: "object" - properties: - virtual-network-context: - description: "Augments the base TAPI Context with VirtualNetworkService information" - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkContext" - x-augmentation: - prefix: "tapi-virtual-network" - namespace: "urn:onf:otcc:yang:tapi-virtual-network" - tapi.virtual.network.CreateVirtualNetworkService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.virtual.network.createvirtualnetworkservice.Output" - tapi.virtual.network.DeleteVirtualNetworkService: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.virtual.network.deletevirtualnetworkservice.Output" - tapi.virtual.network.GetVirtualNetworkServiceDetails: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.virtual.network.getvirtualnetworkservicedetails.Output" - tapi.virtual.network.GetVirtualNetworkServiceList: - type: "object" - properties: - output: - $ref: "#/definitions/tapi.virtual.network.getvirtualnetworkservicelist.Output" - tapi.virtual.network.VirtualNetworkConstraint: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - service-layer: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - requested-capacity: - description: "none" - $ref: "#/definitions/tapi.common.Capacity" - sink-service-end-point: - description: "none" - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - diversity-exclusion: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.virtual.network.VirtualNwServiceRef" - src-service-end-point: - description: "none" - $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" - 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" - 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" - 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" - description: "none" - tapi.virtual.network.VirtualNetworkContext: - type: "object" - properties: - virtual-nw-service: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkService" - tapi.virtual.network.VirtualNetworkService: - allOf: - - $ref: "#/definitions/tapi.common.GlobalClass" - - type: "object" - properties: - schedule: - type: "string" - description: "none" - end-point: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkServiceEndPoint" - topology: - description: "none" - $ref: "#/definitions/tapi.topology.TopologyRef" - layer-protocol-name: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.common.LayerProtocolName" - state: - description: "none" - $ref: "#/definitions/tapi.common.AdminStatePac" - vnw-constraint: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkConstraint" - description: "The ForwardingConstruct (FC) object class models enabled potential\ - \ for forwarding between two or more LTPs and like the LTP supports any transport\ - \ protocol including all circuit and packet forms.\r\n At the\ - \ lowest level of recursion, a FC represents a cross-connection within an\ - \ NE." - tapi.virtual.network.VirtualNetworkServiceEndPoint: - allOf: - - $ref: "#/definitions/tapi.common.LocalClass" - - type: "object" - properties: - service-layer: - description: "none" - $ref: "#/definitions/tapi.common.LayerProtocolName" - 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" - direction: - description: "The orientation of defined flow at the EndPoint." - $ref: "#/definitions/tapi.common.PortDirection" - description: "The association of the FC to LTPs is made via EndPoints.\r\n \ - \ The EndPoint (EP) object class models the access to the FC\ - \ function. \r\n The traffic forwarding between the associated\ - \ EPs of the FC depends upon the type of FC and may be associated with FcSwitch\ - \ object instances. \r\n In cases where there is resilience\ - \ the EndPoint may convey the resilience role of the access to the FC. \r\n\ - \ It can represent a protected (resilient/reliable) point or\ - \ a protecting (unreliable working or protection) point.\r\n \ - \ The EP replaces the Protection Unit of a traditional protection model.\ - \ \r\n The ForwadingConstruct can be considered as a component\ - \ and the EndPoint as a Port on that component" - tapi.virtual.network.VirtualNwServiceRef: - type: "object" - properties: - virtual-nw-service-uuid: - type: "string" - description: "none" - x-path: "/tapi-common:context/tapi-virtual-network:virtual-network-context/tapi-virtual-network:virtual-nw-service/tapi-virtual-network:uuid" - tapi.virtual.network.createvirtualnetworkservice.Input: - type: "object" - properties: - conn-schedule: - type: "string" - description: "none" - vnw-constraint: - description: "none" - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkConstraint" - sep: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkServiceEndPoint" - tapi.virtual.network.createvirtualnetworkservice.Output: - type: "object" - properties: - service: - description: "none" - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkService" - tapi.virtual.network.deletevirtualnetworkservice.Input: - type: "object" - properties: - service-id-or-name: - type: "string" - description: "none" - tapi.virtual.network.deletevirtualnetworkservice.Output: - type: "object" - properties: - service: - description: "none" - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkService" - tapi.virtual.network.getvirtualnetworkservicedetails.Input: - type: "object" - properties: - service-id-or-name: - type: "string" - description: "none" - tapi.virtual.network.getvirtualnetworkservicedetails.Output: - type: "object" - properties: - service: - description: "none" - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkService" - tapi.virtual.network.getvirtualnetworkservicelist.Output: - type: "object" - properties: - service: - type: "array" - description: "none" - items: - $ref: "#/definitions/tapi.virtual.network.VirtualNetworkService" From ad6d1b54eb103831b8480b4af1e39ad90a20b907 Mon Sep 17 00:00:00 2001 From: karthik-sethuraman Date: Fri, 5 Jul 2019 08:46:14 -0400 Subject: [PATCH 2/3] OAS Files for TAPI 2.2 --- OAS/tapi-common@2019-03-31.yaml | 693 + OAS/tapi-connectivity@2019-03-31.yaml | 11291 +++++++++ OAS/tapi-dsr@2019-03-31.yaml | 15816 ++++++++++++ OAS/tapi-equipment@2019-03-31.yaml | 6624 +++++ OAS/tapi-eth@2019-03-31.yaml | 25640 ++++++++++++++++++++ OAS/tapi-notification@2019-03-31.yaml | 1967 ++ OAS/tapi-oam@2019-03-31.yaml | 15800 ++++++++++++ OAS/tapi-odu@2019-03-31.yaml | 17324 +++++++++++++ OAS/tapi-path-computation@2019-03-31.yaml | 7237 ++++++ OAS/tapi-photonic-media@2019-03-31.yaml | 22178 +++++++++++++++++ OAS/tapi-topology@2019-03-31.yaml | 4780 ++++ OAS/tapi-virtual-network@2019-03-31.yaml | 6559 +++++ 12 files changed, 135909 insertions(+) create mode 100644 OAS/tapi-common@2019-03-31.yaml create mode 100644 OAS/tapi-connectivity@2019-03-31.yaml create mode 100644 OAS/tapi-dsr@2019-03-31.yaml create mode 100644 OAS/tapi-equipment@2019-03-31.yaml create mode 100644 OAS/tapi-eth@2019-03-31.yaml create mode 100644 OAS/tapi-notification@2019-03-31.yaml create mode 100644 OAS/tapi-oam@2019-03-31.yaml create mode 100644 OAS/tapi-odu@2019-03-31.yaml create mode 100644 OAS/tapi-path-computation@2019-03-31.yaml create mode 100644 OAS/tapi-photonic-media@2019-03-31.yaml create mode 100644 OAS/tapi-topology@2019-03-31.yaml create mode 100644 OAS/tapi-virtual-network@2019-03-31.yaml diff --git a/OAS/tapi-common@2019-03-31.yaml b/OAS/tapi-common@2019-03-31.yaml new file mode 100644 index 00000000..e040d25b --- /dev/null +++ b/OAS/tapi-common@2019-03-31.yaml @@ -0,0 +1,693 @@ +--- +swagger: "2.0" +info: + description: "\r\n This module contains TAPI Common Model definitions.\r\n\ + \ Source: TapiCommon.uml\r\n Copyright (c) 2018 Open Networking\ + \ Foundation (ONF). All rights reserved.\r\n License: This module is distributed\ + \ under the Apache License 2.0\r\n - The TAPI YANG models included in this\ + \ TAPI release are a *normative* part of the TAPI SDK.\r\n - The YANG specifications\ + \ have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG\ + \ mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases." + version: "2.2.0" + title: "tapi-common API" +host: "localhost:1234" +consumes: +- "application/yang-data+json" +produces: +- "application/yang-data+json" +paths: + /data/context/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.TapiContext" + description: "none" + parameters: [] + responses: + 200: + description: "tapi.common.TapiContext" + schema: + $ref: "#/definitions/tapi.common.TapiContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-common" + summary: "creates tapi.common.TapiContext" + description: "none" + parameters: + - in: "body" + name: "tapi.common.TapiContext.body-param" + description: "tapi.common.TapiContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.TapiContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.TapiContext" + description: "none" + parameters: + - in: "body" + name: "tapi.common.TapiContext.body-param" + description: "tapi.common.TapiContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.TapiContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.TapiContext" + description: "none" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/name/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - in: "body" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/service-interface-point={uuid}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePoint" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/available-capacity/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/name/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/service-interface-point={uuid}/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/total-potential-capacity/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /operations/get-service-interface-point-details/: + post: + tags: + - "tapi-common" + summary: "operates on tapi.common.GetServiceInterfacePointDetails" + description: "operates on tapi.common.GetServiceInterfacePointDetails" + parameters: + - in: "body" + name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.common.GetServiceInterfacePointDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-service-interface-point-list/: + post: + tags: + - "tapi-common" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.common.GetServiceInterfacePointList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-service-interface-point/: + post: + tags: + - "tapi-common" + summary: "operates on tapi.common.UpdateServiceInterfacePoint" + description: "operates on tapi.common.UpdateServiceInterfacePoint" + parameters: + - in: "body" + name: "tapi.common.updateserviceinterfacepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.common.updateserviceinterfacepoint.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" +definitions: + tapi.common.AdminStatePac: + type: "object" + properties: + operational-state: + description: "none" + $ref: "#/definitions/tapi.common.OperationalState" + lifecycle-state: + description: "none" + $ref: "#/definitions/tapi.common.LifecycleState" + administrative-state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + tapi.common.AdministrativeState: + type: "string" + enum: + - "LOCKED" + - "UNLOCKED" + tapi.common.Capacity: + type: "object" + properties: + total-size: + description: "Total capacity of the TopologicalEntity in MB/s. In case of\ + \ bandwidthProfile, this is expected to same as the committedInformationRate." + $ref: "#/definitions/tapi.common.CapacityValue" + tapi.common.CapacityPac: + type: "object" + properties: + available-capacity: + description: "Capacity available to be assigned." + $ref: "#/definitions/tapi.common.Capacity" + total-potential-capacity: + description: "An optimistic view of the capacity of the TopologicalEntity\ + \ assuming that any shared capacity is available to be taken." + $ref: "#/definitions/tapi.common.Capacity" + tapi.common.CapacityUnit: + type: "string" + enum: + - "TB" + - "TBPS" + - "GB" + - "GBPS" + - "MB" + - "MBPS" + - "KB" + - "KBPS" + - "GHz" + - "MHz" + tapi.common.CapacityValue: + type: "object" + properties: + value: + type: "integer" + format: "int32" + description: "none" + unit: + description: "none" + $ref: "#/definitions/tapi.common.CapacityUnit" + tapi.common.GetServiceInterfacePointDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Output" + tapi.common.GetServiceInterfacePointList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.common.getserviceinterfacepointlist.Output" + tapi.common.GlobalClass: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a UUID\ + \ in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.common.LayerProtocolName: + type: "string" + enum: + - "ODU" + - "ETH" + - "DSR" + - "PHOTONIC_MEDIA" + tapi.common.LifecycleState: + type: "string" + enum: + - "PLANNED" + - "POTENTIAL_AVAILABLE" + - "POTENTIAL_BUSY" + - "INSTALLED" + - "PENDING_REMOVAL" + tapi.common.NameAndValue: + type: "object" + properties: + value-name: + type: "string" + description: "The name of the value. The value need not have a name." + value: + type: "string" + description: "The value" + tapi.common.OperationalState: + type: "string" + enum: + - "DISABLED" + - "ENABLED" + tapi.common.ServiceInterfacePoint: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + supported-layer-protocol-qualifier: + type: "array" + description: "none" + items: + type: "string" + layer-protocol-name: + description: "Usage of layerProtocolName [>1] in the ServiceInterfacePoint\ + \ should be considered experimental" + $ref: "#/definitions/tapi.common.LayerProtocolName" + description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ + \ termination and adaptation functions of one or more transport layers. \r\ + \n The structure of LTP supports all transport protocols including\ + \ circuit and packet forms." + tapi.common.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.getserviceinterfacepointdetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.common.getserviceinterfacepointdetails.Output: + type: "object" + properties: + sip: + description: "none" + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + tapi.common.getserviceinterfacepointlist.Output: + type: "object" + properties: + sip: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + tapi.common.updateserviceinterfacepoint.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" diff --git a/OAS/tapi-connectivity@2019-03-31.yaml b/OAS/tapi-connectivity@2019-03-31.yaml new file mode 100644 index 00000000..eb342dd1 --- /dev/null +++ b/OAS/tapi-connectivity@2019-03-31.yaml @@ -0,0 +1,11291 @@ +--- +swagger: "2.0" +info: + description: "\r\n This module contains TAPI Notification Model definitions.\r\ + \n Source: TapiNotification.uml\r\n Copyright (c) 2018 Open Networking\ + \ Foundation (ONF). All rights reserved.\r\n License: This module is distributed\ + \ under the Apache License 2.0\r\n - The TAPI YANG models included in this\ + \ TAPI release are a *normative* part of the TAPI SDK.\r\n - The YANG specifications\ + \ have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG\ + \ mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Topology\ + \ Model definitions.\r\n Source: TapiTopology.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Common Model\ + \ definitions.\r\n Source: TapiCommon.uml\r\n Copyright (c) 2018\ + \ Open Networking Foundation (ONF). All rights reserved.\r\n License: This\ + \ module is distributed under the Apache License 2.0\r\n - The TAPI YANG\ + \ models included in this TAPI release are a *normative* part of the TAPI SDK.\r\ + \n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Path Computation\ + \ Model definitions.\r\n Source: TapiPathComputation.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Connectivity\ + \ Model definitions.\r\n Source: TapiConnectivity.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases." + version: "2.2.0" + title: "tapi-notification,tapi-topology,tapi-common,tapi-path-computation,tapi-connectivity\ + \ API" +host: "localhost:1234" +consumes: +- "application/yang-data+json" +produces: +- "application/yang-data+json" +paths: + /data/context/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Context" + description: "none" + parameters: [] + responses: + 200: + description: "tapi.common.Context" + schema: + $ref: "#/definitions/tapi.common.Context" + 400: + description: "Internal error" + post: + tags: + - "tapi-common" + summary: "creates tapi.common.Context" + description: "none" + parameters: + - in: "body" + name: "tapi.common.Context.body-param" + description: "tapi.common.Context to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.Context" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.Context" + description: "none" + parameters: + - in: "body" + name: "tapi.common.Context.body-param" + description: "tapi.common.Context to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.Context" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.Context" + description: "none" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/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.ConnectivityContext" + 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.ConnectivityContext" + 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.ConnectivityContext" + 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/context/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.Connection" + 400: + description: "Internal error" + /data/context/connectivity-context/connection={uuid}/bounding-node/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.topology.NodeRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connection" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRef" + 400: + description: "Internal error" + ? /data/context/connectivity-context/connection={uuid}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ + : get: + tags: + - "tapi-connectivity" + 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.ConnectionEndPointRef" + 400: + description: "Internal error" + /data/context/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.ConnectionRef" + 400: + description: "Internal error" + /data/context/connectivity-context/connection={uuid}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of 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.NameAndValue" + 400: + description: "Internal error" + /data/context/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.Route" + 400: + description: "Internal error" + ? /data/context/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.ConnectionEndPointRef" + 400: + description: "Internal error" + /data/context/connectivity-context/connection={uuid}/route={local-id}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of 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.NameAndValue" + 400: + description: "Internal error" + /data/context/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.LinkRef" + 400: + description: "Internal error" + /data/context/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.SwitchControl" + 400: + description: "Internal error" + /data/context/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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n 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.NameAndValue" + 400: + description: "Internal error" + ? /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/sub-switch-control={connection-uuid},{sub-switch-control-switch-control-uuid}/ + : get: + tags: + - "tapi-connectivity" + 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.SwitchControlRef" + 400: + description: "Internal error" + /data/context/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.Switch" + 400: + description: "Internal error" + /data/context/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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n 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.NameAndValue" + 400: + description: "Internal error" + ? /data/context/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.ConnectionEndPointRef" + 400: + description: "Internal error" + ? /data/context/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.RouteRef" + 400: + description: "Internal error" + /data/context/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.ConnectivityService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/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.ConnectivityService" + 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.ConnectivityService" + 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/context/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.ConnectionRef" + 400: + description: "Internal error" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.ConnectivityConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.ConnectivityConstraint" + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.connectivity.ConnectivityConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ConnectivityConstraint.body-param" + description: "tapi.connectivity.ConnectivityConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.connectivity.ConnectivityConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ConnectivityConstraint.body-param" + description: "tapi.connectivity.ConnectivityConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.connectivity.ConnectivityConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.ConnectivityServiceRef" + 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.ConnectivityServiceRef" + 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.ConnectivityServiceRef" + 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/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.ConnectivityServiceRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.ConnectivityServiceRef" + 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.ConnectivityServiceRef" + 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/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.Capacity" + 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.Capacity" + 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.Capacity" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.CapacityValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-connectivity" + 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.CapacityValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.TimeRange" + 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.TimeRange" + 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.TimeRange" + 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/context/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.ConnectivityServiceEndPoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/: + 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.ConnectivityServiceEndPoint" + 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.ConnectivityServiceEndPoint" + 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/context/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.Capacity" + 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.Capacity" + 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.Capacity" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/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.CapacityValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-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.CapacityValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/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.ConnectionEndPointRef" + 400: + description: "Internal error" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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/context/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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/server-connectivity-service-end-point/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of 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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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/context/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.ServiceInterfacePointRef" + 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.ServiceInterfacePointRef" + 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.ServiceInterfacePointRef" + 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/context/connectivity-context/connectivity-service={uuid}/name/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/resilience-constraint/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.ResilienceConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.ResilienceConstraint" + schema: + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.connectivity.ResilienceConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ResilienceConstraint.body-param" + description: "tapi.connectivity.ResilienceConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.connectivity.ResilienceConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ResilienceConstraint.body-param" + description: "tapi.connectivity.ResilienceConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.connectivity.ResilienceConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.RoutingConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/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.CostCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + 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.CostCharacteristic" + 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/context/connectivity-context/connectivity-service={uuid}/routing-constraint/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.LatencyCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-connectivity" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + 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.LatencyCharacteristic" + 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/context/connectivity-context/connectivity-service={uuid}/routing-constraint/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.RiskCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/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.RiskCharacteristic" + 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.RiskCharacteristic" + 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/context/connectivity-context/connectivity-service={uuid}/topology-constraint/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.path.computation.TopologyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.path.computation.TopologyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.TopologyConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.path.computation.TopologyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.path.computation.TopologyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/name/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/name/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] + responses: + 200: + description: "tapi.notification.NotificationContext" + schema: + $ref: "#/definitions/tapi.notification.NotificationContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: + - in: "body" + name: "tapi.notification.NotificationContext.body-param" + description: "tapi.notification.NotificationContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: + - in: "body" + name: "tapi.notification.NotificationContext.body-param" + description: "tapi.notification.NotificationContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - in: "body" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NotificationSubscriptionService" + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/name/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/notification-channel/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationChannel" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NotificationChannel" + schema: + $ref: "#/definitions/tapi.notification.NotificationChannel" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.Notification" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.Notification" + schema: + $ref: "#/definitions/tapi.notification.Notification" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.SubscriptionFilter" + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + 400: + description: "Internal error" + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notification={uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.Notification" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.Notification" + schema: + $ref: "#/definitions/tapi.notification.Notification" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/additional-info={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/path-computation-context/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: [] + responses: + 200: + description: "tapi.path.computation.PathComputationContext" + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: + - in: "body" + name: "tapi.path.computation.PathComputationContext.body-param" + description: "tapi.path.computation.PathComputationContext to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: + - in: "body" + name: "tapi.path.computation.PathComputationContext.body-param" + description: "tapi.path.computation.PathComputationContext to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathComputationService" + description: "none" + parameters: + - in: "body" + name: "tapi.path.computation.PathComputationService.body-param" + description: "tapi.path.computation.PathComputationService to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathComputationService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.PathComputationService" + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationService" + 400: + description: "Internal error" + 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.PathComputationService" + 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/context/path-computation-context/path-comp-service={uuid}/end-point/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathServiceEndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.PathServiceEndPoint.body-param" + description: "tapi.path.computation.PathServiceEndPoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathServiceEndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.PathServiceEndPoint" + schema: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-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.PathServiceEndPoint" + 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/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of 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.Capacity" + 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.Capacity" + 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.Capacity" + 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/context/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.CapacityValue" + 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.CapacityValue" + 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.CapacityValue" + 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/context/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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/service-interface-point/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePointRef" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 400: + description: "Internal error" + post: + tags: + - "tapi-path-computation" + 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.ServiceInterfacePointRef" + 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.ServiceInterfacePointRef" + 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/context/path-computation-context/path-comp-service={uuid}/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/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.PathObjectiveFunction" + 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.PathObjectiveFunction" + 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.PathObjectiveFunction" + 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/context/path-computation-context/path-comp-service={uuid}/objective-function/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/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.PathOptimizationConstraint" + 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.PathOptimizationConstraint" + 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.PathOptimizationConstraint" + 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/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/path={path-uuid}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "path-uuid" + in: "path" + description: "Id of path" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.PathRef" + schema: + $ref: "#/definitions/tapi.path.computation.PathRef" + 400: + description: "Internal error" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.RoutingConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + 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.CostCharacteristic" + 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/context/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.LatencyCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-path-computation" + 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.LatencyCharacteristic" + 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.LatencyCharacteristic" + 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/context/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.RiskCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-path-computation" + 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.RiskCharacteristic" + 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.RiskCharacteristic" + 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/context/path-computation-context/path-comp-service={uuid}/topology-constraint/: + 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.TopologyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/: + 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" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.TopologyConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + 400: + description: "Internal error" + put: + tags: + - "tapi-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" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object 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" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/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.Path" + 400: + description: "Internal error" + /data/context/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.LinkRef" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/: + get: + tags: + - "tapi-path-computation" + 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.RoutingConstraint" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-path-computation" + 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.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/: + get: + tags: + - "tapi-path-computation" + 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.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/service-interface-point/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - in: "body" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/service-interface-point={uuid}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePoint" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/available-capacity/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/name/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/service-interface-point={uuid}/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/total-potential-capacity/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] + responses: + 200: + description: "tapi.topology.TopologyContext" + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-topology" + summary: "creates tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: + - in: "body" + name: "tapi.topology.context.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-topology" + summary: "creates or updates tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: + - in: "body" + name: "tapi.topology.context.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-topology" + summary: "removes tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/topology-context/nw-topology-service/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NetworkTopologyService" + description: "none" + parameters: [] + responses: + 200: + description: "tapi.topology.NetworkTopologyService" + schema: + $ref: "#/definitions/tapi.topology.NetworkTopologyService" + 400: + description: "Internal error" + /data/context/topology-context/nw-topology-service/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.TopologyRef" + description: "none" + parameters: + - name: "topology-uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.topologycontext.Topology" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Topology" + schema: + $ref: "#/definitions/tapi.topology.Topology" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/boundary-node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Link" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Link" + schema: + $ref: "#/definitions/tapi.topology.Link" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.ValidationMechanism" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "validation-mechanism" + in: "path" + description: "Id of validation-mechanism" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.ValidationMechanism" + schema: + $ref: "#/definitions/tapi.topology.ValidationMechanism" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.topology.Node" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.topology.Node" + schema: + $ref: "#/definitions/tapi.topology.topology.Node" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.TopologyRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.node.NodeEdgePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.node.NodeEdgePoint" + schema: + $ref: "#/definitions/tapi.topology.node.NodeEdgePoint" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{aggregated-node-edge-point-node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-cep-layer-protocol={layer-protocol-qualifier}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NepLayerProtocolCapability" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "layer-protocol-qualifier" + in: "path" + description: "Id of available-cep-layer-protocol" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NepLayerProtocolCapability" + schema: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.CepList" + schema: + $ref: "#/definitions/tapi.connectivity.CepList" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ + : get: + tags: + - "tapi-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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.ConnectionEndPoint" + schema: + $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/aggregated-connection-end-point={topology-uuid},{aggregated-connection-end-point-node-uuid},{aggregated-connection-end-point-node-edge-point-uuid},{aggregated-connection-end-point-connection-end-point-uuid}/ + : get: + tags: + - "tapi-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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-connection-end-point" + required: true + type: "string" + - name: "aggregated-connection-end-point-node-uuid" + in: "path" + description: "Id of aggregated-connection-end-point" + required: true + type: "string" + - name: "aggregated-connection-end-point-node-edge-point-uuid" + in: "path" + description: "Id of 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.ConnectionEndPointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/client-node-edge-point={topology-uuid},{client-node-edge-point-node-uuid},{client-node-edge-point-node-edge-point-uuid}/ + : get: + tags: + - "tapi-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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of client-node-edge-point" + required: true + type: "string" + - name: "client-node-edge-point-node-uuid" + in: "path" + description: "Id of client-node-edge-point" + required: true + type: "string" + - name: "client-node-edge-point-node-edge-point-uuid" + in: "path" + description: "Id of client-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load balancing/Resilience)\ + \ should be considered experimental" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "service-interface-point-uuid" + in: "path" + description: "Id of mapped-service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePointRef" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroup" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroup" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-rule-group-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroupRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.InterRuleGroup" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.InterRuleGroup" + schema: + $ref: "#/definitions/tapi.topology.InterRuleGroup" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + - name: "associated-node-rule-group-node-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + - name: "associated-node-rule-group-node-rule-group-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroupRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Rule" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Rule" + schema: + $ref: "#/definitions/tapi.topology.Rule" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-node-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Rule" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Rule" + schema: + $ref: "#/definitions/tapi.topology.Rule" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /operations/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/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/create-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.CreateNotificationSubscriptionService" + description: "operates on tapi.notification.CreateNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.CreateNotificationSubscriptionService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-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/delete-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.DeleteNotificationSubscriptionService" + description: "operates on tapi.notification.DeleteNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.deletenotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/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/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/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/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/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/get-link-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetLinkDetails" + description: "operates on tapi.topology.GetLinkDetails" + parameters: + - in: "body" + name: "tapi.topology.getlinkdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getlinkdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetLinkDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-node-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetNodeDetails" + description: "operates on tapi.topology.GetNodeDetails" + parameters: + - in: "body" + name: "tapi.topology.getnodedetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getnodedetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetNodeDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-node-edge-point-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetNodeEdgePointDetails" + description: "operates on tapi.topology.GetNodeEdgePointDetails" + parameters: + - in: "body" + name: "tapi.topology.getnodeedgepointdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetNodeEdgePointDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-list/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationList" + description: "operates on tapi.notification.GetNotificationList" + parameters: + - in: "body" + name: "tapi.notification.getnotificationlist.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.getnotificationlist.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-subscription-service-details/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + description: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + parameters: + - in: "body" + name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-subscription-service-list/: + post: + tags: + - "tapi-notification" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-service-interface-point-details/: + post: + tags: + - "tapi-common" + summary: "operates on tapi.common.GetServiceInterfacePointDetails" + description: "operates on tapi.common.GetServiceInterfacePointDetails" + parameters: + - in: "body" + name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.common.GetServiceInterfacePointDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-service-interface-point-list/: + post: + tags: + - "tapi-common" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.common.GetServiceInterfacePointList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-supported-notification-types/: + post: + tags: + - "tapi-notification" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetSupportedNotificationTypes" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-topology-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetTopologyDetails" + description: "operates on tapi.topology.GetTopologyDetails" + parameters: + - in: "body" + name: "tapi.topology.gettopologydetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.gettopologydetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetTopologyDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-topology-list/: + post: + tags: + - "tapi-topology" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetTopologyList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/optimize-p-2-p-path/: + 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/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/update-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.UpdateNotificationSubscriptionService" + description: "operates on tapi.notification.UpdateNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.UpdateNotificationSubscriptionService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-service-interface-point/: + post: + tags: + - "tapi-common" + summary: "operates on tapi.common.UpdateServiceInterfacePoint" + description: "operates on tapi.common.UpdateServiceInterfacePoint" + parameters: + - in: "body" + name: "tapi.common.updateserviceinterfacepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.common.updateserviceinterfacepoint.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" +definitions: + tapi.common.AdminStatePac: + type: "object" + properties: + operational-state: + description: "none" + $ref: "#/definitions/tapi.common.OperationalState" + lifecycle-state: + description: "none" + $ref: "#/definitions/tapi.common.LifecycleState" + administrative-state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + tapi.common.AdministrativeState: + type: "string" + enum: + - "LOCKED" + - "UNLOCKED" + tapi.common.Capacity: + type: "object" + properties: + total-size: + description: "Total capacity of the TopologicalEntity in MB/s. In case of\ + \ bandwidthProfile, this is expected to same as the committedInformationRate." + $ref: "#/definitions/tapi.common.CapacityValue" + tapi.common.CapacityPac: + type: "object" + properties: + available-capacity: + description: "Capacity available to be assigned." + $ref: "#/definitions/tapi.common.Capacity" + total-potential-capacity: + description: "An optimistic view of the capacity of the TopologicalEntity\ + \ assuming that any shared capacity is available to be taken." + $ref: "#/definitions/tapi.common.Capacity" + tapi.common.CapacityUnit: + type: "string" + enum: + - "TB" + - "TBPS" + - "GB" + - "GBPS" + - "MB" + - "MBPS" + - "KB" + - "KBPS" + - "GHz" + - "MHz" + tapi.common.CapacityValue: + type: "object" + properties: + value: + type: "integer" + format: "int32" + description: "none" + unit: + description: "none" + $ref: "#/definitions/tapi.common.CapacityUnit" + tapi.common.Context: + allOf: + - $ref: "#/definitions/tapi.common.TapiContext" + - $ref: "#/definitions/tapi.connectivity.ContextAugmentation3" + - $ref: "#/definitions/tapi.notification.ContextAugmentation1" + - $ref: "#/definitions/tapi.path.computation.ContextAugmentation2" + - $ref: "#/definitions/tapi.topology.ContextAugmentation4" + 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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a UUID\ + \ in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.common.LayerProtocolName: + type: "string" + enum: + - "ODU" + - "ETH" + - "DSR" + - "PHOTONIC_MEDIA" + tapi.common.LifecycleState: + type: "string" + enum: + - "PLANNED" + - "POTENTIAL_AVAILABLE" + - "POTENTIAL_BUSY" + - "INSTALLED" + - "PENDING_REMOVAL" + tapi.common.LocalClass: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + local-id: + type: "string" + description: "none" + tapi.common.NameAndValue: + type: "object" + properties: + value-name: + type: "string" + description: "The name of the value. The value need not have a name." + value: + type: "string" + description: "The value" + tapi.common.OperationalState: + type: "string" + enum: + - "DISABLED" + - "ENABLED" + tapi.common.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" + description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ + \ termination and adaptation functions of one or more transport layers. \r\ + \n The structure of LTP supports all transport protocols including\ + \ circuit and packet forms." + tapi.common.ServiceInterfacePointRef: + type: "object" + properties: + service-interface-point-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-common:service-interface-point/tapi-common:uuid" + tapi.common.TapiContext: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + service-interface-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + description: "The Network Control Domain (NCD) object class represents the scope\ + \ of control that a particular SDN controller has with respect to a particular\ + \ network, (i.e., encompassing a designated set of interconnected (virtual)\ + \ network elements)." + tapi.common.TerminationDirection: + type: "string" + enum: + - "BIDIRECTIONAL" + - "SINK" + - "SOURCE" + - "UNDEFINED_OR_UNKNOWN" + tapi.common.TerminationPac: + type: "object" + properties: + termination-direction: + description: "The overall directionality of the LP. \r\n -\ + \ A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ + \ - A SINK LP can only contain elements with SINK flows or CONTRA_DIRECTION_SOURCE\ + \ flows\r\n - A SOURCE LP can only contain SOURCE flows or\ + \ CONTRA_DIRECTION_SINK flows" + $ref: "#/definitions/tapi.common.TerminationDirection" + termination-state: + description: "Indicates whether the layer is terminated and if so how." + $ref: "#/definitions/tapi.common.TerminationState" + tapi.common.TerminationState: + type: "string" + enum: + - "LP_CAN_NEVER_TERMINATE" + - "LT_NOT_TERMINATED" + - "TERMINATED_SERVER_TO_CLIENT_FLOW" + - "TERMINATED_CLIENT_TO_SERVER_FLOW" + - "TERMINATED_BIDIRECTIONAL" + - "LT_PERMENANTLY_TERMINATED" + - "TERMINATION_STATE_UNKNOWN" + tapi.common.TimeRange: + type: "object" + properties: + end-time: + type: "string" + description: "none" + start-time: + type: "string" + description: "none" + tapi.common.getserviceinterfacepointdetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.common.getserviceinterfacepointdetails.Output: + type: "object" + properties: + sip: + description: "none" + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + tapi.common.getserviceinterfacepointlist.Output: + type: "object" + properties: + sip: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + tapi.common.updateserviceinterfacepoint.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + tapi.connectivity.CepList: + type: "object" + properties: + connection-end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" + 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" + bounding-node: + description: "none" + $ref: "#/definitions/tapi.topology.NodeRef" + 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: + protection-role: + description: "none" + $ref: "#/definitions/tapi.connectivity.ProtectionRole" + 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" + 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:node-edge-point/tapi-connectivity:cep-list/tapi-connectivity:connection-end-point/tapi-connectivity:uuid" + description: "none" + 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.ConnectivityConstraint: + type: "object" + properties: + schedule: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + requested-capacity: + description: "none" + $ref: "#/definitions/tapi.common.Capacity" + diversity-exclusion: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + 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\r\n Class of Service Name." + service-type: + description: "none" + $ref: "#/definitions/tapi.connectivity.ServiceType" + coroute-inclusion: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + tapi.connectivity.ConnectivityContext: + type: "object" + properties: + connectivity-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectivityService" + connection: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.Connection" + tapi.connectivity.ConnectivityService: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + connection: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "The ForwardingConstruct (FC) object class models enabled potential\ + \ for forwarding between two or more LTPs and like the LTP supports any transport\ + \ protocol including all circuit and packet forms.\r\n At the lowest\ + \ level of recursion, a FC represents a cross-connection within an NE." + 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" + direction: + description: "The orientation of defined flow at the EndPoint." + $ref: "#/definitions/tapi.common.PortDirection" + capacity: + description: "none" + $ref: "#/definitions/tapi.common.Capacity" + protecting-connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + description: "The association of the FC to LTPs is made via EndPoints.\r\n \ + \ The EndPoint (EP) object class models the access to the FC function.\ + \ \r\n The traffic forwarding between the associated EPs of the\ + \ FC depends upon the type of FC and may be associated with FcSwitch object\ + \ instances. \r\n In cases where there is resilience the EndPoint\ + \ may convey the resilience role of the access to the FC. \r\n \ + \ It can represent a protected (resilient/reliable) point or a protecting\ + \ (unreliable working or protection) point.\r\n The EP replaces\ + \ the Protection Unit of a traditional protection model. \r\n The\ + \ ForwadingConstruct can be considered as a component and the EndPoint as\ + \ a Port on that component" + tapi.connectivity.ConnectivityServiceEndPointRef: + allOf: + - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + - type: "object" + properties: + connectivity-service-end-point-local-id: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-connectivity:connectivity-context/tapi-connectivity:connectivity-service/tapi-connectivity:end-point/tapi-connectivity:local-id" + description: "none" + tapi.connectivity.ConnectivityServiceRef: + type: "object" + properties: + 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.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.NodeEdgePointAugmentation1: + 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." + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" + hold-off-time: + type: "integer" + format: "int32" + description: "This attribute indicates the time, in milliseconds, between\ + \ declaration of signal degrade or signal fail, and the initialization of\ + \ the protection switching algorithm." + 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 + selection-control: + description: "Degree of administrative control applied to the switch selection." + $ref: "#/definitions/tapi.connectivity.SelectionControl" + preferred-restoration-layer: + type: "array" + description: "Indicate which layer this resilience parameters package configured\ + \ for." + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + restore-priority: + type: "integer" + format: "int32" + description: "none" + restoration-policy: + description: "none" + $ref: "#/definitions/tapi.topology.RestorationPolicy" + restoration-coordinate-type: + description: " The coordination mechanism between multi-layers." + $ref: "#/definitions/tapi.connectivity.CoordinateType" + is-coordinated-switching-both-ends: + type: "boolean" + description: "Is operating such that switching at both ends of each flow acorss\ + \ the FC is coordinated at both ingress and egress ends." + default: false + fault-condition-determination: + type: "string" + description: "none" + is-frozen: + type: "boolean" + description: "Temporarily prevents any switch action to be taken and, as such,\ + \ freezes the current state. \r\n Until the freeze is cleared,\ + \ additional near-end external commands are rejected and fault condition\ + \ changes and received APS messages are ignored.\r\n All\ + \ administrative controls of any aspect of protection are rejected." + default: false + reversion-mode: + description: "Indcates whether the protection scheme is revertive or non-revertive." + $ref: "#/definitions/tapi.connectivity.ReversionMode" + 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" + description: "The FC Route (FcRoute) object class models the individual routes\ + \ of an FC. \r\n The route of an FC object is represented by a\ + \ list of FCs at a lower level. \r\n Note that depending on the\ + \ service supported by an FC, an the FC can have multiple routes." + 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.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-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.UpdateConnectivityService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.connectivity.updateconnectivityservice.Output" + tapi.connectivity.createconnectivityservice.Input: + type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.createconnectivityservice.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityService" + tapi.connectivity.deleteconnectivityservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.getconnectiondetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.getconnectiondetails.Output: + type: "object" + properties: + connection: + description: "none" + $ref: "#/definitions/tapi.connectivity.Connection" + tapi.connectivity.getconnectionendpointdetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.getconnectionendpointdetails.Output: + type: "object" + properties: + connection-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" + tapi.connectivity.getconnectivityservicedetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.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: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.updateconnectivityservice.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityService" + tapi.notification.ContextAugmentation1: + type: "object" + properties: + notification-context: + description: "Augments the base TAPI Context with NotificationService information" + $ref: "#/definitions/tapi.notification.NotificationContext" + x-augmentation: + prefix: "tapi-notification" + namespace: "urn:onf:otcc:yang:tapi-notification" + tapi.notification.CreateNotificationSubscriptionService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Output" + tapi.notification.GetNotificationList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationlist.Output" + tapi.notification.GetNotificationSubscriptionServiceDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Output" + tapi.notification.GetNotificationSubscriptionServiceList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicelist.Output" + tapi.notification.GetSupportedNotificationTypes: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getsupportednotificationtypes.Output" + tapi.notification.NameAndValueChange: + type: "object" + properties: + value-name: + type: "string" + description: "The name of the value. The value need not have a name." + old-value: + type: "string" + description: "The value" + new-value: + type: "string" + description: "The value" + tapi.notification.Notification: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + target-object-type: + type: "string" + description: "none" + additional-text: + type: "string" + description: "none" + event-time-stamp: + type: "string" + description: "none" + additional-info: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.NameAndValue" + sequence-number: + type: "integer" + format: "int32" + description: "A monotonous increasing sequence number associated with the\ + \ notification.\r\n The exact semantics of how this sequence\ + \ number is assigned (per channel or subscription or source or system)\ + \ is left undefined." + target-object-identifier: + type: "string" + description: "none" + notification-type: + type: "string" + description: "none" + target-object-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.NameAndValue" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + source-indicator: + description: "none" + $ref: "#/definitions/tapi.notification.SourceIndicator" + layer-protocol-qualifier: + type: "string" + description: "none" + changed-attributes: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + description: "none" + tapi.notification.NotificationChannel: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + next-sequence-no: + type: "integer" + format: "int32" + description: "The sequence number of the next notification that will be\ + \ published on the channel" + stream-address: + type: "string" + description: "The address/location/URI of the channel/stream to which the\ + \ subscribed notifications are published.\r\n This specifics\ + \ of this is typically dependent on the implementation protocol & mechanism\ + \ and hence is typed as a string." + description: "none" + tapi.notification.NotificationContext: + type: "object" + properties: + notif-subscription: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.Notification" + tapi.notification.NotificationSubscriptionService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.Notification" + notification-channel: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationChannel" + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + supported-object-types: + type: "array" + description: "none" + items: + type: "string" + supported-notification-types: + type: "array" + description: "none" + items: + type: "string" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + description: "none" + tapi.notification.SourceIndicator: + type: "string" + enum: + - "RESOURCE_OPERATION" + - "MANAGEMENT_OPERATION" + - "UNKNOWN" + tapi.notification.SubscriptionFilter: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + requested-notification-types: + type: "array" + description: "none" + items: + type: "string" + requested-object-identifier: + type: "array" + description: "none" + items: + type: "string" + requested-layer-protocols: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + include-content: + type: "boolean" + description: "Indicates whether the published Notification includes content\ + \ or just the Notification Id (which enables retrieval of the notification\ + \ at the later stage)" + default: false + requested-object-types: + type: "array" + description: "none" + items: + type: "string" + description: "none" + tapi.notification.SubscriptionState: + type: "string" + enum: + - "SUSPENDED" + - "ACTIVE" + tapi.notification.UpdateNotificationSubscriptionService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Output" + tapi.notification.createnotificationsubscriptionservice.Input: + type: "object" + properties: + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + tapi.notification.createnotificationsubscriptionservice.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.deletenotificationsubscriptionservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationlist.Input: + type: "object" + properties: + time-range: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + subscription-id: + type: "string" + description: "UUID of the associated Notification Subscription Service: An\ + \ identifier that is universally unique within an identifier space, where\ + \ the identifier space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationlist.Output: + type: "object" + properties: + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.Notification" + tapi.notification.getnotificationsubscriptionservicedetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationsubscriptionservicedetails.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.getnotificationsubscriptionservicelist.Output: + type: "object" + properties: + subscription-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.getsupportednotificationtypes.Output: + type: "object" + properties: + supported-object-types: + type: "array" + description: "none" + items: + type: "string" + supported-notification-types: + type: "array" + description: "none" + items: + type: "string" + tapi.notification.updatenotificationsubscriptionservice.Input: + type: "object" + properties: + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + tapi.notification.updatenotificationsubscriptionservice.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.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.PathComputationService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $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" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + optimization-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "none" + tapi.path.computation.PathObjectiveFunction: + allOf: + - $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.PathOptimizationConstraint: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + traffic-interruption: + description: "none" + $ref: "#/definitions/tapi.common.DirectiveValue" + description: "none" + 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.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.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 + tolerable-impact: + type: "string" + description: "Grades of maximum tolerable disruption to traffic." + 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" + 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" + tapi.path.computation.TopologyConstraint: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + include-node: + type: "string" + description: "This is a loose constraint - that is it is unordered and could\ + \ be a partial list" + exclude-link: + type: "string" + description: "none" + avoid-topology: + type: "string" + description: "none" + exclude-path: + type: "string" + description: "none" + include-topology: + type: "string" + description: "none" + include-path: + type: "string" + description: "none" + exclude-node-edge-point: + type: "string" + description: "none" + include-node-edge-point: + type: "string" + description: "none" + include-link: + type: "string" + description: "This is a loose constraint - that is it is unordered and could\ + \ be a partial list " + preferred-transport-layer: + description: "soft constraint requested by client to indicate the layer(s)\ + \ of transport connection that it prefers to carry the service. This could\ + \ be same as the service layer or one of the supported server layers" + $ref: "#/definitions/tapi.common.LayerProtocolName" + exclude-node: + type: "string" + description: "none" + constraint-weight: + type: "integer" + format: "int32" + description: "Zero and positive values: zero means 'strongly required to\ + \ be included', +1 means 'less strongly required to be included', etc.\r\ + \n For example the work/intended route will be calculated\ + \ considering the topologies which weights are lowest (but not negative).\r\ + \n Negative values: -1 means 'strongly required to be excluded',\ + \ -2 means 'less strongly required to be excluded', etc." + description: "The TopologyConstraint allows to specify topology entities in\ + \ order to impose specific constraints (as denoted by the attribute name)\ + \ on Connectivity/Path.\r\n The topology entities are specified\ + \ by their instance uuid rather than using references/path (to allow for mapping\ + \ to Yang 1.0).\r\n This loose typing and reference necessitates\ + \ that implementations validate not only the presence of the instance, but\ + \ also that it is of the correct type as implied by the attribute name.\r\n\ + \ If this validation fails, then the implementation is expceted\ + \ to return an error.\r\n " + tapi.path.computation.computep2ppath.Input: + type: "object" + properties: + topology-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + objective-function: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.path.computation.computep2ppath.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathComputationService" + tapi.path.computation.deletep2ppath.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.path.computation.deletep2ppath.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathComputationService" + tapi.path.computation.optimizep2ppath.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + optimization-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + objective-function: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + tapi.path.computation.optimizep2ppath.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathComputationService" + 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.ForwardingRule: + type: "string" + enum: + - "MAY_FORWARD_ACROSS_GROUP" + - "MUST_FORWARD_ACROSS_GROUP" + - "CANNOT_FORWARD_ACROSS_GROUP" + - "NO_STATEMENT_ON_FORWARDING" + tapi.topology.GetLinkDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getlinkdetails.Output" + tapi.topology.GetNodeDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getnodedetails.Output" + tapi.topology.GetNodeEdgePointDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Output" + tapi.topology.GetTopologyDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.gettopologydetails.Output" + tapi.topology.GetTopologyList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.gettopologylist.Output" + tapi.topology.InterRuleGroup: + allOf: + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + associated-node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + rule: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Rule" + description: "none" + tapi.topology.LatencyCharacteristic: + type: "object" + properties: + traffic-property-name: + type: "string" + description: "The identifier of the specific traffic property to which the\ + \ queuing latency applies." + jitter-characteristic: + type: "string" + description: "High frequency deviation from true periodicity of a signal and\ + \ therefore a small high rate of change of transfer latency.\r\n \ + \ Applies to TDM systems (and not packet)." + fixed-latency-characteristic: + type: "string" + description: "A TopologicalEntity suffers delay caused by the realization\ + \ of the servers (e.g. distance related; FEC encoding etc.) along with some\ + \ client specific processing. This is the total average latency effect of\ + \ the TopologicalEntity" + wander-characteristic: + type: "string" + description: "Low frequency deviation from true periodicity of a signal and\ + \ therefore a small low rate of change of transfer latency.\r\n \ + \ Applies to TDM systems (and not packet)." + queing-latency-characteristic: + type: "string" + description: "The specific queuing latency for the traffic property." + tapi.topology.LayerProtocolTransitionPac: + type: "object" + properties: + transitioned-layer-protocol-name: + type: "array" + description: "Provides the ordered structure of layer protocol transitions\ + \ encapsulated in the TopologicalEntity. The ordering relates to the LinkPort\ + \ role." + items: + type: "string" + tapi.topology.Link: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.LayerProtocolTransitionPac" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - $ref: "#/definitions/tapi.topology.ValidationPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + restoration-policy: + description: "none" + $ref: "#/definitions/tapi.topology.RestorationPolicy" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" + direction: + description: "The directionality of the Link. \r\n Is applicable\ + \ to simple Links where all LinkEnds are BIDIRECTIONAL (the Link will\ + \ be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ + \ \r\n Is not present in more complex cases." + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "The Link object class models effective adjacency between two or\ + \ more ForwardingDomains (FD). " + tapi.topology.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.NepLayerProtocolCapability: + type: "object" + properties: + layer-protocol-qualifier: + type: "string" + description: "none" + number-of-cep-instances: + type: "integer" + format: "int32" + description: "none" + tapi.topology.NetworkTopologyService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.TopologyRef" + description: "none" + tapi.topology.Node: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + encap-topology: + description: "none" + $ref: "#/definitions/tapi.topology.TopologyRef" + node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePoint" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ + \ topological component which is used to effect forwarding of transport characteristic\ + \ information and offers the potential to enable forwarding. \r\n \ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ multiple switch matrices (FDs). " + tapi.topology.NodeEdgePoint: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.common.TerminationPac" + - type: "object" + properties: + link-port-role: + description: "Each LinkEnd of the Link has a role (e.g., symmetric, hub,\ + \ spoke, leaf, root) in the context of the Link with respect to the Link\ + \ function. " + $ref: "#/definitions/tapi.common.PortRole" + mapped-service-interface-point: + type: "array" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load\ + \ balancing/Resilience) should be considered experimental" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + available-cep-layer-protocol: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + link-port-direction: + description: "The orientation of defined flow at the LinkEnd." + $ref: "#/definitions/tapi.common.PortDirection" + description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ + \ termination and adaptation functions of one or more transport layers. \r\ + \n The structure of LTP supports all transport protocols including\ + \ circuit and packet forms." + tapi.topology.NodeEdgePointRef: + allOf: + - $ref: "#/definitions/tapi.topology.NodeRef" + - type: "object" + properties: + node-edge-point-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-edge-point/tapi-topology:uuid" + description: "none" + tapi.topology.NodeRef: + allOf: + - $ref: "#/definitions/tapi.topology.TopologyRef" + - type: "object" + properties: + node-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:uuid" + description: "none" + tapi.topology.NodeRuleGroup: + allOf: + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + inter-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.InterRuleGroup" + rule: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Rule" + composed-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "none" + tapi.topology.NodeRuleGroupRef: + allOf: + - $ref: "#/definitions/tapi.topology.NodeRef" + - type: "object" + properties: + node-rule-group-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-rule-group/tapi-topology:uuid" + description: "none" + tapi.topology.ProtectionType: + type: "string" + enum: + - "NO_PROTECTION" + - "ONE_PLUS_ONE_PROTECTION" + - "ONE_FOR_ONE_PROTECTION" + - "ONE_FOR_N_PROTECTION" + - "M_FOR_N_PROTECTION" + - "ONE_FOR_ONE_BY_N" + tapi.topology.RestorationPolicy: + type: "string" + enum: + - "PER_DOMAIN_RESTORATION" + - "END_TO_END_RESTORATION" + - "NA" + - "DYNAMIC_RESTORATION" + - "PRE_COMPUTED_RESTORATION" + tapi.topology.RiskCharacteristic: + type: "object" + properties: + risk-characteristic-name: + type: "string" + description: "The name of the risk characteristic. The characteristic may\ + \ be related to a specific degree of closeness. \r\n For\ + \ example a particular characteristic may apply to failures that are localized\ + \ (e.g. to one side of a road) where as another characteristic may relate\ + \ to failures that have a broader impact (e.g. both sides of a road that\ + \ crosses a bridge).\r\n Depending upon the importance of\ + \ the traffic being routed different risk characteristics will be evaluated." + risk-identifier-list: + type: "array" + description: "A list of the identifiers of each physical/geographic unit (with\ + \ the specific risk characteristic) that is related to a segment of the\ + \ TopologicalEntity." + items: + type: "string" + tapi.topology.RiskParameterPac: + type: "object" + properties: + risk-characteristic: + type: "array" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + items: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + tapi.topology.Rule: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + override-priority: + type: "integer" + format: "int32" + description: "none" + forwarding-rule: + description: "none" + $ref: "#/definitions/tapi.topology.ForwardingRule" + rule-type: + description: "none" + $ref: "#/definitions/tapi.topology.RuleType" + description: "none" + tapi.topology.RuleType: + type: "string" + enum: + - "FORWARDING" + - "CAPACITY" + - "COST" + - "TIMING" + - "RISK" + - "GROUPING" + tapi.topology.Topology: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + link: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Link" + node: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Node" + boundary-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ + \ topological component which is used to effect forwarding of transport characteristic\ + \ information and offers the potential to enable forwarding. \r\n \ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ multiple switch matrices (FDs). " + tapi.topology.TopologyContext: + type: "object" + properties: + nw-topology-service: + description: "none" + $ref: "#/definitions/tapi.topology.NetworkTopologyService" + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.TopologyRef: + type: "object" + properties: + topology-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:uuid" + tapi.topology.TransferCostPac: + type: "object" + properties: + cost-characteristic: + type: "array" + description: "The list of costs where each cost relates to some aspect of\ + \ the TopologicalEntity." + items: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + tapi.topology.TransferIntegrityPac: + type: "object" + properties: + error-characteristic: + type: "string" + description: "Describes the degree to which the signal propagated can be errored.\ + \ \r\n Applies to TDM systems as the errored signal will\ + \ be propagated and not packet as errored packets will be discarded." + unavailable-time-characteristic: + type: "string" + description: "Describes the duration for which there may be no valid signal\ + \ propagated." + server-integrity-process-characteristic: + type: "string" + description: "Describes the effect of any server integrity enhancement process\ + \ on the characteristics of the TopologicalEntity." + delivery-order-characteristic: + type: "string" + description: "Describes the degree to which packets will be delivered out\ + \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ + \ maintain strict order." + repeat-delivery-characteristic: + type: "string" + description: "Primarily applies to packet systems where a packet may be delivered\ + \ more than once (in fault recovery for example). \r\n It\ + \ can also apply to TDM where several frames may be received twice due to\ + \ switching in a system with a large differential propagation delay." + loss-characteristic: + type: "string" + description: "Describes the acceptable characteristic of lost packets where\ + \ loss may result from discard due to errors or overflow.\r\n \ + \ Applies to packet systems and not TDM (as for TDM errored signals\ + \ are propagated unless grossly errored and overflow/underflow turns into\ + \ timing slips)." + tapi.topology.TransferTimingPac: + type: "object" + properties: + latency-characteristic: + type: "array" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + items: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + tapi.topology.ValidationMechanism: + type: "object" + properties: + layer-protocol-adjacency-validated: + type: "string" + description: "State of validatiion" + validation-mechanism: + type: "string" + description: "Name of mechanism used to validate adjacency" + validation-robustness: + type: "string" + description: "Quality of validation (i.e. how likely is the stated validation\ + \ to be invalid)" + tapi.topology.ValidationPac: + type: "object" + properties: + validation-mechanism: + type: "array" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." + items: + $ref: "#/definitions/tapi.topology.ValidationMechanism" + tapi.topology.getlinkdetails.Input: + type: "object" + properties: + link-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getlinkdetails.Output: + type: "object" + properties: + link: + description: "none" + $ref: "#/definitions/tapi.topology.Link" + tapi.topology.getnodedetails.Input: + type: "object" + properties: + node-id: + type: "string" + description: "UUID of the Node: An identifier that is universally unique within\ + \ an identifier space, where the identifier space is itself globally unique,\ + \ and immutable.\r\n An UUID carries no semantics with\ + \ respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The canonical\ + \ representation uses lowercase characters.\r\n Pattern:\ + \ [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getnodedetails.Output: + type: "object" + properties: + node: + description: "none" + $ref: "#/definitions/tapi.topology.Node" + tapi.topology.getnodeedgepointdetails.Input: + type: "object" + properties: + node-id: + type: "string" + description: "UUID of the parent Node: An identifier that is universally unique\ + \ within an identifier space, where the identifier space is itself globally\ + \ unique, and immutable.\r\n An UUID carries no semantics\ + \ with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The\ + \ canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Node's Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + node-edge-point-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getnodeedgepointdetails.Output: + type: "object" + properties: + node-edge-point: + description: "none" + $ref: "#/definitions/tapi.topology.NodeEdgePoint" + tapi.topology.gettopologydetails.Input: + type: "object" + properties: + topology-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.gettopologydetails.Output: + type: "object" + properties: + topology: + description: "none" + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.gettopologylist.Output: + type: "object" + properties: + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.node.NodeEdgePoint: + allOf: + - $ref: "#/definitions/tapi.connectivity.NodeEdgePointAugmentation1" + - $ref: "#/definitions/tapi.topology.NodeEdgePoint" + tapi.topology.topology.Node: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + encap-topology: + description: "none" + $ref: "#/definitions/tapi.topology.TopologyRef" + node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.node.NodeEdgePoint" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "none" diff --git a/OAS/tapi-dsr@2019-03-31.yaml b/OAS/tapi-dsr@2019-03-31.yaml new file mode 100644 index 00000000..cfcc3400 --- /dev/null +++ b/OAS/tapi-dsr@2019-03-31.yaml @@ -0,0 +1,15816 @@ +--- +swagger: "2.0" +info: + description: "\r\n This module contains TAPI Notification Model definitions.\r\ + \n Source: TapiNotification.uml\r\n Copyright (c) 2018 Open Networking\ + \ Foundation (ONF). All rights reserved.\r\n License: This module is distributed\ + \ under the Apache License 2.0\r\n - The TAPI YANG models included in this\ + \ TAPI release are a *normative* part of the TAPI SDK.\r\n - The YANG specifications\ + \ have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG\ + \ mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Topology\ + \ Model definitions.\r\n Source: TapiTopology.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI DSR Model\ + \ definitions.\r\n Source: TapiDsr.uml\r\n Copyright (c) 2018 Open\ + \ Networking Foundation (ONF). All rights reserved.\r\n License: This module\ + \ is distributed under the Apache License 2.0\r\n - The TAPI YANG models\ + \ included in this TAPI release are a *normative* part of the TAPI SDK.\r\n \ + \ - The YANG specifications have been generated from the corresponding UML\ + \ model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Common Model\ + \ definitions.\r\n Source: TapiCommon.uml\r\n Copyright (c) 2018\ + \ Open Networking Foundation (ONF). All rights reserved.\r\n License: This\ + \ module is distributed under the Apache License 2.0\r\n - The TAPI YANG\ + \ models included in this TAPI release are a *normative* part of the TAPI SDK.\r\ + \n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Path Computation\ + \ Model definitions.\r\n Source: TapiPathComputation.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Connectivity\ + \ Model definitions.\r\n Source: TapiConnectivity.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI OAM Model\ + \ definitions.\r\n Source: TapiOam.uml\r\n Copyright (c) 2018 Open\ + \ Networking Foundation (ONF). All rights reserved.\r\n License: This module\ + \ is distributed under the Apache License 2.0\r\n - The TAPI YANG models\ + \ included in this TAPI release are a *normative* part of the TAPI SDK.\r\n \ + \ - The YANG specifications have been generated from the corresponding UML\ + \ model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases." + version: "2.2.0" + title: "tapi-notification,tapi-topology,tapi-dsr,tapi-common,tapi-path-computation,tapi-connectivity,tapi-oam\ + \ API" +host: "localhost:1234" +consumes: +- "application/yang-data+json" +produces: +- "application/yang-data+json" +paths: + /data/context/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Context" + description: "none" + parameters: [] + responses: + 200: + description: "tapi.common.Context" + schema: + $ref: "#/definitions/tapi.common.Context" + 400: + description: "Internal error" + post: + tags: + - "tapi-common" + summary: "creates tapi.common.Context" + description: "none" + parameters: + - in: "body" + name: "tapi.common.Context.body-param" + description: "tapi.common.Context to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.Context" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.Context" + description: "none" + parameters: + - in: "body" + name: "tapi.common.Context.body-param" + description: "tapi.common.Context to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.Context" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.Context" + description: "none" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/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.ConnectivityContext" + 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.ConnectivityContext" + 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.ConnectivityContext" + 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/context/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.Connection" + 400: + description: "Internal error" + /data/context/connectivity-context/connection={uuid}/bounding-node/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.topology.NodeRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connection" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRef" + 400: + description: "Internal error" + ? /data/context/connectivity-context/connection={uuid}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ + : get: + tags: + - "tapi-connectivity" + 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.ConnectionEndPointRef" + 400: + description: "Internal error" + /data/context/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.ConnectionRef" + 400: + description: "Internal error" + /data/context/connectivity-context/connection={uuid}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of 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.NameAndValue" + 400: + description: "Internal error" + /data/context/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.Route" + 400: + description: "Internal error" + ? /data/context/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.ConnectionEndPointRef" + 400: + description: "Internal error" + /data/context/connectivity-context/connection={uuid}/route={local-id}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of 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.NameAndValue" + 400: + description: "Internal error" + /data/context/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.LinkRef" + 400: + description: "Internal error" + /data/context/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.SwitchControl" + 400: + description: "Internal error" + /data/context/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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n 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.NameAndValue" + 400: + description: "Internal error" + ? /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/sub-switch-control={connection-uuid},{sub-switch-control-switch-control-uuid}/ + : get: + tags: + - "tapi-connectivity" + 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.SwitchControlRef" + 400: + description: "Internal error" + /data/context/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.Switch" + 400: + description: "Internal error" + /data/context/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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n 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.NameAndValue" + 400: + description: "Internal error" + ? /data/context/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.ConnectionEndPointRef" + 400: + description: "Internal error" + ? /data/context/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.RouteRef" + 400: + description: "Internal error" + /data/context/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.ConnectivityService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/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.ConnectivityService" + 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.ConnectivityService" + 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/context/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.ConnectionRef" + 400: + description: "Internal error" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.ConnectivityConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.ConnectivityConstraint" + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.connectivity.ConnectivityConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ConnectivityConstraint.body-param" + description: "tapi.connectivity.ConnectivityConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.connectivity.ConnectivityConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ConnectivityConstraint.body-param" + description: "tapi.connectivity.ConnectivityConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.connectivity.ConnectivityConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.ConnectivityServiceRef" + 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.ConnectivityServiceRef" + 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.ConnectivityServiceRef" + 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/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.ConnectivityServiceRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.ConnectivityServiceRef" + 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.ConnectivityServiceRef" + 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/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.Capacity" + 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.Capacity" + 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.Capacity" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.CapacityValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-connectivity" + 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.CapacityValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.TimeRange" + 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.TimeRange" + 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.TimeRange" + 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/context/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.ConnectivityServiceEndPoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/: + 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.ConnectivityServiceEndPoint" + 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.ConnectivityServiceEndPoint" + 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/context/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.Capacity" + 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.Capacity" + 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.Capacity" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/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.CapacityValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-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.CapacityValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/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.ConnectionEndPointRef" + 400: + description: "Internal error" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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/context/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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/server-connectivity-service-end-point/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of 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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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/context/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.ServiceInterfacePointRef" + 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.ServiceInterfacePointRef" + 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.ServiceInterfacePointRef" + 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/context/connectivity-context/connectivity-service={uuid}/name/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/resilience-constraint/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.ResilienceConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.ResilienceConstraint" + schema: + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.connectivity.ResilienceConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ResilienceConstraint.body-param" + description: "tapi.connectivity.ResilienceConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.connectivity.ResilienceConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ResilienceConstraint.body-param" + description: "tapi.connectivity.ResilienceConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.connectivity.ResilienceConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.RoutingConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/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.CostCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + 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.CostCharacteristic" + 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/context/connectivity-context/connectivity-service={uuid}/routing-constraint/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.LatencyCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-connectivity" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + 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.LatencyCharacteristic" + 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/context/connectivity-context/connectivity-service={uuid}/routing-constraint/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.RiskCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/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.RiskCharacteristic" + 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.RiskCharacteristic" + 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/context/connectivity-context/connectivity-service={uuid}/topology-constraint/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.path.computation.TopologyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.path.computation.TopologyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.TopologyConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.path.computation.TopologyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.path.computation.TopologyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/name/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/name/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] + responses: + 200: + description: "tapi.notification.context.NotificationContext" + schema: + $ref: "#/definitions/tapi.notification.context.NotificationContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: + - in: "body" + name: "tapi.notification.context.NotificationContext.body-param" + description: "tapi.notification.context.NotificationContext to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.notification.context.NotificationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: + - in: "body" + name: "tapi.notification.context.NotificationContext.body-param" + description: "tapi.notification.context.NotificationContext to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.context.NotificationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - in: "body" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NotificationSubscriptionService" + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/name/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/notification-channel/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationChannel" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NotificationChannel" + schema: + $ref: "#/definitions/tapi.notification.NotificationChannel" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.Notification" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.Notification" + schema: + $ref: "#/definitions/tapi.notification.Notification" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.SubscriptionFilter" + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + 400: + description: "Internal error" + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notification={uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.notificationcontext.Notification" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.notificationcontext.Notification" + schema: + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/additional-info={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/alarm-info/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.AlarmInfo" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.AlarmInfo" + schema: + $ref: "#/definitions/tapi.oam.AlarmInfo" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.TcaInfo" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.TcaInfo" + schema: + $ref: "#/definitions/tapi.oam.TcaInfo" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/oam-job/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamJobRef" + description: "MEF 35.1\r\n Identification of the PM Session for\ + \ which the TCA Function was configured." + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamJobRef" + schema: + $ref: "#/definitions/tapi.oam.OamJobRef" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.ThresholdParameter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.ThresholdParameter" + schema: + $ref: "#/definitions/tapi.oam.ThresholdParameter" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-above-thrs/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-below-thrs/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-clear-thrs/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + /data/context/oam-context/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: [] + responses: + 200: + description: "tapi.oam.OamContext" + schema: + $ref: "#/definitions/tapi.oam.OamContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: + - in: "body" + name: "tapi.oam.OamContext.body-param" + description: "tapi.oam.OamContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: + - in: "body" + name: "tapi.oam.OamContext.body-param" + description: "tapi.oam.OamContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/meg={uuid}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.Meg" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.Meg" + schema: + $ref: "#/definitions/tapi.oam.Meg" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.Mep" + description: "1. ME may have 0 MEPs (case of transit domains where at least\ + \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case of edge\ + \ domaind, where the peer MEP is ouside the managed domain)\r\n \ + \ 3. ME may have 2 MEPs" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.Mep" + schema: + $ref: "#/definitions/tapi.oam.Mep" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mip={local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.Mip" + description: "ME may 0, 1, or more MIPs" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.Mip" + schema: + $ref: "#/definitions/tapi.oam.Mip" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mip={local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/oam-context/oam-job/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamJob" + description: "none" + parameters: + - in: "body" + name: "tapi.oam.OamJob.body-param" + description: "tapi.oam.OamJob to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamJob" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-job={uuid}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamJob" + schema: + $ref: "#/definitions/tapi.oam.OamJob" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamJob.body-param" + description: "tapi.oam.OamJob to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamJob" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.CurrentData" + description: "Granularity period of the CurrentData identifies the specific\ + \ CurrentData instance in the scope of this OamJob.\r\n For\ + \ example, typically at least\r\n one 15min and\r\n \ + \ one 24hr;\r\n optionally one additional configurable\ + \ (< 15min)" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.CurrentData" + schema: + $ref: "#/definitions/tapi.oam.CurrentData" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/elapsed-time/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimeInterval" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimeInterval" + schema: + $ref: "#/definitions/tapi.common.TimeInterval" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/elapsed-time/period={unit}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "unit" + in: "path" + description: "Id of period" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimePeriod" + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.HistoryData" + description: "in case of 24hr Current Data, at least 1 History Data.\r\n \ + \ In case of 15min Current Data, at least 16 History Data.\r\n\ + \ In case of <15min, the number of History Data shall be able\ + \ to cover a span of 4 hours." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.HistoryData" + schema: + $ref: "#/definitions/tapi.oam.HistoryData" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/pm-data-pac/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmDataPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmDataPac" + schema: + $ref: "#/definitions/tapi.oam.PmDataPac" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/pm-data-pac/granularity-period/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimePeriod" + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/pm-data-pac/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmDataPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmDataPac" + schema: + $ref: "#/definitions/tapi.oam.PmDataPac" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/pm-data-pac/granularity-period/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimePeriod" + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-job={uuid}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/oam-profile/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamProfileRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamProfileRef" + schema: + $ref: "#/definitions/tapi.oam.OamProfileRef" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamProfileRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamProfileRef.body-param" + description: "tapi.oam.OamProfileRef to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfileRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamProfileRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamProfileRef.body-param" + description: "tapi.oam.OamProfileRef to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfileRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamProfileRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamServicePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamServicePointRef.body-param" + description: "tapi.oam.OamServicePointRef to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamServicePointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-job={uuid}/oam-service-point={oam-service-uuid},{oam-service-point-local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamServicePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "oam-service-uuid" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "oam-service-point-local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamServicePointRef" + schema: + $ref: "#/definitions/tapi.oam.OamServicePointRef" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamServicePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "oam-service-uuid" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "oam-service-point-local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamServicePointRef.body-param" + description: "tapi.oam.OamServicePointRef to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamServicePointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamServicePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "oam-service-uuid" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "oam-service-point-local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/schedule/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimeRange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimeRange" + schema: + $ref: "#/definitions/tapi.common.TimeRange" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.TimeRange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.TimeRange" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.TimeRange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.TimeRange" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.TimeRange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamProfile" + description: "none" + parameters: + - in: "body" + name: "tapi.oam.OamProfile.body-param" + description: "tapi.oam.OamProfile to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfile" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamProfile" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamProfile" + schema: + $ref: "#/definitions/tapi.oam.OamProfile" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamProfile" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamProfile.body-param" + description: "tapi.oam.OamProfile to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfile" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamProfile" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.PmThresholdData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmThresholdData.body-param" + description: "tapi.oam.PmThresholdData to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmThresholdData" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmThresholdData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmThresholdData" + schema: + $ref: "#/definitions/tapi.oam.PmThresholdData" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.PmThresholdData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmThresholdData.body-param" + description: "tapi.oam.PmThresholdData to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmThresholdData" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.PmThresholdData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/granularity-period/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimePeriod" + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - in: "body" + name: "tapi.common.TimePeriod.body-param" + description: "tapi.common.TimePeriod to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - in: "body" + name: "tapi.common.TimePeriod.body-param" + description: "tapi.common.TimePeriod to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.ThresholdParameter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - in: "body" + name: "tapi.oam.ThresholdParameter.body-param" + description: "tapi.oam.ThresholdParameter to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.ThresholdParameter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.ThresholdParameter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.ThresholdParameter" + schema: + $ref: "#/definitions/tapi.oam.ThresholdParameter" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.ThresholdParameter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.ThresholdParameter.body-param" + description: "tapi.oam.ThresholdParameter to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.ThresholdParameter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.ThresholdParameter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-above-thrs/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-below-thrs/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-clear-thrs/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamService" + description: "none" + parameters: + - in: "body" + name: "tapi.oam.OamService.body-param" + description: "tapi.oam.OamService to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-service={uuid}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamService" + schema: + $ref: "#/definitions/tapi.oam.OamService" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamService.body-param" + description: "tapi.oam.OamService to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/meg/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MegRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MegRef" + schema: + $ref: "#/definitions/tapi.oam.MegRef" + 400: + description: "Internal error" + /data/context/oam-context/oam-service={uuid}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-service={uuid}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamServicePoint.body-param" + description: "tapi.oam.OamServicePoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamServicePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamServicePoint" + schema: + $ref: "#/definitions/tapi.oam.OamServicePoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamServicePoint.body-param" + description: "tapi.oam.OamServicePoint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamServicePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/connectivity-service-end-point/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.ConnectivityServiceEndPointRef" + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/mep/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MepRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MepRef" + schema: + $ref: "#/definitions/tapi.oam.MepRef" + 400: + description: "Internal error" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/mip/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MipRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MipRef" + schema: + $ref: "#/definitions/tapi.oam.MipRef" + 400: + description: "Internal error" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/service-interface-point/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePointRef" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: [] + responses: + 200: + description: "tapi.path.computation.PathComputationContext" + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: + - in: "body" + name: "tapi.path.computation.PathComputationContext.body-param" + description: "tapi.path.computation.PathComputationContext to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: + - in: "body" + name: "tapi.path.computation.PathComputationContext.body-param" + description: "tapi.path.computation.PathComputationContext to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathComputationService" + description: "none" + parameters: + - in: "body" + name: "tapi.path.computation.PathComputationService.body-param" + description: "tapi.path.computation.PathComputationService to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathComputationService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.PathComputationService" + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationService" + 400: + description: "Internal error" + 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.PathComputationService" + 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/context/path-computation-context/path-comp-service={uuid}/end-point/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathServiceEndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.PathServiceEndPoint.body-param" + description: "tapi.path.computation.PathServiceEndPoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathServiceEndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.PathServiceEndPoint" + schema: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-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.PathServiceEndPoint" + 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/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of 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.Capacity" + 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.Capacity" + 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.Capacity" + 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/context/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.CapacityValue" + 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.CapacityValue" + 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.CapacityValue" + 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/context/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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/service-interface-point/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePointRef" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 400: + description: "Internal error" + post: + tags: + - "tapi-path-computation" + 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.ServiceInterfacePointRef" + 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.ServiceInterfacePointRef" + 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/context/path-computation-context/path-comp-service={uuid}/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/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.PathObjectiveFunction" + 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.PathObjectiveFunction" + 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.PathObjectiveFunction" + 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/context/path-computation-context/path-comp-service={uuid}/objective-function/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/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.PathOptimizationConstraint" + 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.PathOptimizationConstraint" + 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.PathOptimizationConstraint" + 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/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/path={path-uuid}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "path-uuid" + in: "path" + description: "Id of path" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.PathRef" + schema: + $ref: "#/definitions/tapi.path.computation.PathRef" + 400: + description: "Internal error" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.RoutingConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + 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.CostCharacteristic" + 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/context/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.LatencyCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-path-computation" + 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.LatencyCharacteristic" + 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.LatencyCharacteristic" + 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/context/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.RiskCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-path-computation" + 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.RiskCharacteristic" + 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.RiskCharacteristic" + 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/context/path-computation-context/path-comp-service={uuid}/topology-constraint/: + 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.TopologyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/: + 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" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.TopologyConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + 400: + description: "Internal error" + put: + tags: + - "tapi-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" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object 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" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/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.Path" + 400: + description: "Internal error" + /data/context/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.LinkRef" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/: + get: + tags: + - "tapi-path-computation" + 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.RoutingConstraint" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-path-computation" + 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.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/: + get: + tags: + - "tapi-path-computation" + 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.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/service-interface-point/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - in: "body" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/service-interface-point={uuid}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePoint" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/available-capacity/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/name/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/service-interface-point={uuid}/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/total-potential-capacity/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] + responses: + 200: + description: "tapi.topology.TopologyContext" + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-topology" + summary: "creates tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: + - in: "body" + name: "tapi.topology.context.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-topology" + summary: "creates or updates tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: + - in: "body" + name: "tapi.topology.context.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-topology" + summary: "removes tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/topology-context/nw-topology-service/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NetworkTopologyService" + description: "none" + parameters: [] + responses: + 200: + description: "tapi.topology.NetworkTopologyService" + schema: + $ref: "#/definitions/tapi.topology.NetworkTopologyService" + 400: + description: "Internal error" + /data/context/topology-context/nw-topology-service/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.TopologyRef" + description: "none" + parameters: + - name: "topology-uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.topologycontext.Topology" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Topology" + schema: + $ref: "#/definitions/tapi.topology.Topology" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/boundary-node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Link" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Link" + schema: + $ref: "#/definitions/tapi.topology.Link" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.ValidationMechanism" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "validation-mechanism" + in: "path" + description: "Id of validation-mechanism" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.ValidationMechanism" + schema: + $ref: "#/definitions/tapi.topology.ValidationMechanism" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.topology.Node" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.topology.Node" + schema: + $ref: "#/definitions/tapi.topology.topology.Node" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.TopologyRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.node.NodeEdgePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.node.NodeEdgePoint" + schema: + $ref: "#/definitions/tapi.topology.node.NodeEdgePoint" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{aggregated-node-edge-point-node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-cep-layer-protocol={layer-protocol-qualifier}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NepLayerProtocolCapability" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "layer-protocol-qualifier" + in: "path" + description: "Id of available-cep-layer-protocol" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NepLayerProtocolCapability" + schema: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" + schema: + $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ + : get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.ceplist.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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.ceplist.ConnectionEndPoint" + schema: + $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/aggregated-connection-end-point={topology-uuid},{aggregated-connection-end-point-node-uuid},{aggregated-connection-end-point-node-edge-point-uuid},{aggregated-connection-end-point-connection-end-point-uuid}/ + : get: + tags: + - "tapi-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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-connection-end-point" + required: true + type: "string" + - name: "aggregated-connection-end-point-node-uuid" + in: "path" + description: "Id of aggregated-connection-end-point" + required: true + type: "string" + - name: "aggregated-connection-end-point-node-edge-point-uuid" + in: "path" + description: "Id of 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.ConnectionEndPointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/client-node-edge-point={topology-uuid},{client-node-edge-point-node-uuid},{client-node-edge-point-node-edge-point-uuid}/ + : get: + tags: + - "tapi-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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of client-node-edge-point" + required: true + type: "string" + - name: "client-node-edge-point-node-uuid" + in: "path" + description: "Id of client-node-edge-point" + required: true + type: "string" + - name: "client-node-edge-point-node-edge-point-uuid" + in: "path" + description: "Id of client-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MepMipList" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MepMipList" + schema: + $ref: "#/definitions/tapi.oam.MepMipList" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mep={meg-uuid},{mep-local-id}/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MepRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "meg-uuid" + in: "path" + description: "Id of mep" + required: true + type: "string" + - name: "mep-local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MepRef" + schema: + $ref: "#/definitions/tapi.oam.MepRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mip={meg-uuid},{mip-local-id}/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MipRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "meg-uuid" + in: "path" + description: "Id of mip" + required: true + type: "string" + - name: "mip-local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MipRef" + schema: + $ref: "#/definitions/tapi.oam.MipRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load balancing/Resilience)\ + \ should be considered experimental" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "service-interface-point-uuid" + in: "path" + description: "Id of mapped-service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePointRef" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroup" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroup" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-rule-group-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroupRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.InterRuleGroup" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.InterRuleGroup" + schema: + $ref: "#/definitions/tapi.topology.InterRuleGroup" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + - name: "associated-node-rule-group-node-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + - name: "associated-node-rule-group-node-rule-group-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroupRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Rule" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Rule" + schema: + $ref: "#/definitions/tapi.topology.Rule" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-node-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Rule" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Rule" + schema: + $ref: "#/definitions/tapi.topology.Rule" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /operations/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/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/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/create-oam-job/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.CreateOamJob" + description: "operates on tapi.oam.CreateOamJob" + parameters: + - in: "body" + name: "tapi.oam.createoamjob.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.createoamjob.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.CreateOamJob" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/create-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.CreateOamProfile" + description: "operates on tapi.oam.CreateOamProfile" + parameters: + - in: "body" + name: "tapi.oam.createoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.createoamprofile.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.CreateOamProfile" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/create-oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.CreateOamServicePoint" + description: "operates on tapi.oam.CreateOamServicePoint" + parameters: + - in: "body" + name: "tapi.oam.createoamservicepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.createoamservicepoint.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.CreateOamServicePoint" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/create-oam-service/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.CreateOamService" + description: "operates on tapi.oam.CreateOamService" + parameters: + - in: "body" + name: "tapi.oam.createoamservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.createoamservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.CreateOamService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/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/delete-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.DeleteNotificationSubscriptionService" + description: "operates on tapi.notification.DeleteNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.deletenotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-oam-job/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamJob" + description: "operates on tapi.oam.DeleteOamJob" + parameters: + - in: "body" + name: "tapi.oam.deleteoamjob.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.deleteoamjob.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamProfile" + description: "operates on tapi.oam.DeleteOamProfile" + parameters: + - in: "body" + name: "tapi.oam.deleteoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.deleteoamprofile.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamServicePoint" + description: "operates on tapi.oam.DeleteOamServicePoint" + parameters: + - in: "body" + name: "tapi.oam.deleteoamservicepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.deleteoamservicepoint.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-oam-service/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamService" + description: "operates on tapi.oam.DeleteOamService" + parameters: + - in: "body" + name: "tapi.oam.deleteoamservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.deleteoamservice.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/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/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/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/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/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/get-link-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetLinkDetails" + description: "operates on tapi.topology.GetLinkDetails" + parameters: + - in: "body" + name: "tapi.topology.getlinkdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getlinkdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetLinkDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-meg/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.GetMeg" + description: "operates on tapi.oam.GetMeg" + parameters: + - in: "body" + name: "tapi.oam.getmeg.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getmeg.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetMeg" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-node-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetNodeDetails" + description: "operates on tapi.topology.GetNodeDetails" + parameters: + - in: "body" + name: "tapi.topology.getnodedetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getnodedetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetNodeDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-node-edge-point-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetNodeEdgePointDetails" + description: "operates on tapi.topology.GetNodeEdgePointDetails" + parameters: + - in: "body" + name: "tapi.topology.getnodeedgepointdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetNodeEdgePointDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-list/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationList" + description: "operates on tapi.notification.GetNotificationList" + parameters: + - in: "body" + name: "tapi.notification.getnotificationlist.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.getnotificationlist.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-subscription-service-details/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + description: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + parameters: + - in: "body" + name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-subscription-service-list/: + post: + tags: + - "tapi-notification" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-job-list/: + post: + tags: + - "tapi-oam" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamJobList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-job/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.GetOamJob" + description: "operates on tapi.oam.GetOamJob" + parameters: + - in: "body" + name: "tapi.oam.getoamjob.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getoamjob.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamJob" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-profile-list/: + post: + tags: + - "tapi-oam" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamProfileList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.GetOamProfile" + description: "operates on tapi.oam.GetOamProfile" + parameters: + - in: "body" + name: "tapi.oam.getoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getoamprofile.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamProfile" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-service-list/: + post: + tags: + - "tapi-oam" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamServiceList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.GetOamServicePoint" + description: "operates on tapi.oam.GetOamServicePoint" + parameters: + - in: "body" + name: "tapi.oam.getoamservicepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getoamservicepoint.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamServicePoint" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-service/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.GetOamService" + description: "operates on tapi.oam.GetOamService" + parameters: + - in: "body" + name: "tapi.oam.getoamservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getoamservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-service-interface-point-details/: + post: + tags: + - "tapi-common" + summary: "operates on tapi.common.GetServiceInterfacePointDetails" + description: "operates on tapi.common.GetServiceInterfacePointDetails" + parameters: + - in: "body" + name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.common.GetServiceInterfacePointDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-service-interface-point-list/: + post: + tags: + - "tapi-common" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.common.GetServiceInterfacePointList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-supported-notification-types/: + post: + tags: + - "tapi-notification" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetSupportedNotificationTypes" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-topology-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetTopologyDetails" + description: "operates on tapi.topology.GetTopologyDetails" + parameters: + - in: "body" + name: "tapi.topology.gettopologydetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.gettopologydetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetTopologyDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-topology-list/: + post: + tags: + - "tapi-topology" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetTopologyList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/optimize-p-2-p-path/: + 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/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/update-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.UpdateNotificationSubscriptionService" + description: "operates on tapi.notification.UpdateNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.UpdateNotificationSubscriptionService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-oam-job/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamJob" + description: "operates on tapi.oam.UpdateOamJob" + parameters: + - in: "body" + name: "tapi.oam.updateoamjob.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.updateoamjob.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.UpdateOamJob" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamProfile" + description: "operates on tapi.oam.UpdateOamProfile" + parameters: + - in: "body" + name: "tapi.oam.updateoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.updateoamprofile.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.UpdateOamProfile" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamServicePoint" + description: "operates on tapi.oam.UpdateOamServicePoint" + parameters: + - in: "body" + name: "tapi.oam.updateoamservicepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.updateoamservicepoint.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.UpdateOamServicePoint" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-oam-service/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamService" + description: "operates on tapi.oam.UpdateOamService" + parameters: + - in: "body" + name: "tapi.oam.updateoamservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.updateoamservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.UpdateOamService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-service-interface-point/: + post: + tags: + - "tapi-common" + summary: "operates on tapi.common.UpdateServiceInterfacePoint" + description: "operates on tapi.common.UpdateServiceInterfacePoint" + parameters: + - in: "body" + name: "tapi.common.updateserviceinterfacepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.common.updateserviceinterfacepoint.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" +definitions: + tapi.common.AdminStatePac: + type: "object" + properties: + operational-state: + description: "none" + $ref: "#/definitions/tapi.common.OperationalState" + lifecycle-state: + description: "none" + $ref: "#/definitions/tapi.common.LifecycleState" + administrative-state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + tapi.common.AdministrativeState: + type: "string" + enum: + - "LOCKED" + - "UNLOCKED" + tapi.common.Capacity: + type: "object" + properties: + total-size: + description: "Total capacity of the TopologicalEntity in MB/s. In case of\ + \ bandwidthProfile, this is expected to same as the committedInformationRate." + $ref: "#/definitions/tapi.common.CapacityValue" + tapi.common.CapacityPac: + type: "object" + properties: + available-capacity: + description: "Capacity available to be assigned." + $ref: "#/definitions/tapi.common.Capacity" + total-potential-capacity: + description: "An optimistic view of the capacity of the TopologicalEntity\ + \ assuming that any shared capacity is available to be taken." + $ref: "#/definitions/tapi.common.Capacity" + tapi.common.CapacityUnit: + type: "string" + enum: + - "TB" + - "TBPS" + - "GB" + - "GBPS" + - "MB" + - "MBPS" + - "KB" + - "KBPS" + - "GHz" + - "MHz" + tapi.common.CapacityValue: + type: "object" + properties: + value: + type: "integer" + format: "int32" + description: "none" + unit: + description: "none" + $ref: "#/definitions/tapi.common.CapacityUnit" + tapi.common.Context: + allOf: + - $ref: "#/definitions/tapi.common.TapiContext" + - $ref: "#/definitions/tapi.connectivity.ContextAugmentation4" + - $ref: "#/definitions/tapi.notification.ContextAugmentation2" + - $ref: "#/definitions/tapi.oam.ContextAugmentation3" + - $ref: "#/definitions/tapi.path.computation.ContextAugmentation1" + - $ref: "#/definitions/tapi.topology.ContextAugmentation5" + 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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a UUID\ + \ in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.common.LayerProtocolName: + type: "string" + enum: + - "ODU" + - "ETH" + - "DSR" + - "PHOTONIC_MEDIA" + tapi.common.LifecycleState: + type: "string" + enum: + - "PLANNED" + - "POTENTIAL_AVAILABLE" + - "POTENTIAL_BUSY" + - "INSTALLED" + - "PENDING_REMOVAL" + tapi.common.LocalClass: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + local-id: + type: "string" + description: "none" + tapi.common.NameAndValue: + type: "object" + properties: + value-name: + type: "string" + description: "The name of the value. The value need not have a name." + value: + type: "string" + description: "The value" + tapi.common.OperationalState: + type: "string" + enum: + - "DISABLED" + - "ENABLED" + tapi.common.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" + description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ + \ termination and adaptation functions of one or more transport layers. \r\ + \n The structure of LTP supports all transport protocols including\ + \ circuit and packet forms." + tapi.common.ServiceInterfacePointRef: + type: "object" + properties: + service-interface-point-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-common:service-interface-point/tapi-common:uuid" + tapi.common.TapiContext: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + service-interface-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + description: "The Network Control Domain (NCD) object class represents the scope\ + \ of control that a particular SDN controller has with respect to a particular\ + \ network, (i.e., encompassing a designated set of interconnected (virtual)\ + \ network elements)." + tapi.common.TerminationDirection: + type: "string" + enum: + - "BIDIRECTIONAL" + - "SINK" + - "SOURCE" + - "UNDEFINED_OR_UNKNOWN" + tapi.common.TerminationPac: + type: "object" + properties: + termination-direction: + description: "The overall directionality of the LP. \r\n -\ + \ A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ + \ - A SINK LP can only contain elements with SINK flows or CONTRA_DIRECTION_SOURCE\ + \ flows\r\n - A SOURCE LP can only contain SOURCE flows or\ + \ CONTRA_DIRECTION_SINK flows" + $ref: "#/definitions/tapi.common.TerminationDirection" + termination-state: + description: "Indicates whether the layer is terminated and if so how." + $ref: "#/definitions/tapi.common.TerminationState" + tapi.common.TerminationState: + type: "string" + enum: + - "LP_CAN_NEVER_TERMINATE" + - "LT_NOT_TERMINATED" + - "TERMINATED_SERVER_TO_CLIENT_FLOW" + - "TERMINATED_CLIENT_TO_SERVER_FLOW" + - "TERMINATED_BIDIRECTIONAL" + - "LT_PERMENANTLY_TERMINATED" + - "TERMINATION_STATE_UNKNOWN" + tapi.common.TimeInterval: + type: "object" + properties: + period: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.TimePeriod" + tapi.common.TimePeriod: + type: "object" + properties: + value: + type: "integer" + format: "int32" + description: "none" + unit: + description: "none" + $ref: "#/definitions/tapi.common.TimeUnit" + tapi.common.TimeRange: + type: "object" + properties: + end-time: + type: "string" + description: "none" + start-time: + type: "string" + description: "none" + tapi.common.TimeUnit: + type: "string" + enum: + - "YEARS" + - "MONTHS" + - "DAYS" + - "HOURS" + - "MINUTES" + - "SECONDS" + - "MILLISECONDS" + - "MICROSECONDS" + - "NANOSECONDS" + - "PICOSECONDS" + tapi.common.getserviceinterfacepointdetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.common.getserviceinterfacepointdetails.Output: + type: "object" + properties: + sip: + description: "none" + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + tapi.common.getserviceinterfacepointlist.Output: + type: "object" + properties: + sip: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + tapi.common.updateserviceinterfacepoint.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + tapi.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" + bounding-node: + description: "none" + $ref: "#/definitions/tapi.topology.NodeRef" + 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: + protection-role: + description: "none" + $ref: "#/definitions/tapi.connectivity.ProtectionRole" + 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" + 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:node-edge-point/tapi-connectivity:cep-list/tapi-connectivity:connection-end-point/tapi-connectivity:uuid" + description: "none" + 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.ConnectivityConstraint: + type: "object" + properties: + schedule: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + requested-capacity: + description: "none" + $ref: "#/definitions/tapi.common.Capacity" + diversity-exclusion: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + 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\r\n Class of Service Name." + service-type: + description: "none" + $ref: "#/definitions/tapi.connectivity.ServiceType" + coroute-inclusion: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + tapi.connectivity.ConnectivityContext: + type: "object" + properties: + connectivity-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectivityService" + connection: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.Connection" + tapi.connectivity.ConnectivityService: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + connection: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "The ForwardingConstruct (FC) object class models enabled potential\ + \ for forwarding between two or more LTPs and like the LTP supports any transport\ + \ protocol including all circuit and packet forms.\r\n At the lowest\ + \ level of recursion, a FC represents a cross-connection within an NE." + 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" + direction: + description: "The orientation of defined flow at the EndPoint." + $ref: "#/definitions/tapi.common.PortDirection" + capacity: + description: "none" + $ref: "#/definitions/tapi.common.Capacity" + protecting-connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + description: "The association of the FC to LTPs is made via EndPoints.\r\n \ + \ The EndPoint (EP) object class models the access to the FC function.\ + \ \r\n The traffic forwarding between the associated EPs of the\ + \ FC depends upon the type of FC and may be associated with FcSwitch object\ + \ instances. \r\n In cases where there is resilience the EndPoint\ + \ may convey the resilience role of the access to the FC. \r\n \ + \ It can represent a protected (resilient/reliable) point or a protecting\ + \ (unreliable working or protection) point.\r\n The EP replaces\ + \ the Protection Unit of a traditional protection model. \r\n The\ + \ ForwadingConstruct can be considered as a component and the EndPoint as\ + \ a Port on that component" + tapi.connectivity.ConnectivityServiceEndPointRef: + allOf: + - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + - type: "object" + properties: + connectivity-service-end-point-local-id: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-connectivity:connectivity-context/tapi-connectivity:connectivity-service/tapi-connectivity:end-point/tapi-connectivity:local-id" + description: "none" + tapi.connectivity.ConnectivityServiceRef: + type: "object" + properties: + 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.ContextAugmentation4: + 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.NodeEdgePointAugmentation1: + type: "object" + properties: + cep-list: + description: "none" + $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.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." + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" + hold-off-time: + type: "integer" + format: "int32" + description: "This attribute indicates the time, in milliseconds, between\ + \ declaration of signal degrade or signal fail, and the initialization of\ + \ the protection switching algorithm." + 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 + selection-control: + description: "Degree of administrative control applied to the switch selection." + $ref: "#/definitions/tapi.connectivity.SelectionControl" + preferred-restoration-layer: + type: "array" + description: "Indicate which layer this resilience parameters package configured\ + \ for." + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + restore-priority: + type: "integer" + format: "int32" + description: "none" + restoration-policy: + description: "none" + $ref: "#/definitions/tapi.topology.RestorationPolicy" + restoration-coordinate-type: + description: " The coordination mechanism between multi-layers." + $ref: "#/definitions/tapi.connectivity.CoordinateType" + is-coordinated-switching-both-ends: + type: "boolean" + description: "Is operating such that switching at both ends of each flow acorss\ + \ the FC is coordinated at both ingress and egress ends." + default: false + fault-condition-determination: + type: "string" + description: "none" + is-frozen: + type: "boolean" + description: "Temporarily prevents any switch action to be taken and, as such,\ + \ freezes the current state. \r\n Until the freeze is cleared,\ + \ additional near-end external commands are rejected and fault condition\ + \ changes and received APS messages are ignored.\r\n All\ + \ administrative controls of any aspect of protection are rejected." + default: false + reversion-mode: + description: "Indcates whether the protection scheme is revertive or non-revertive." + $ref: "#/definitions/tapi.connectivity.ReversionMode" + 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" + description: "The FC Route (FcRoute) object class models the individual routes\ + \ of an FC. \r\n The route of an FC object is represented by a\ + \ list of FCs at a lower level. \r\n Note that depending on the\ + \ service supported by an FC, an the FC can have multiple routes." + 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.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-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.UpdateConnectivityService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.connectivity.updateconnectivityservice.Output" + tapi.connectivity.ceplist.ConnectionEndPoint: + allOf: + - $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" + - $ref: "#/definitions/tapi.oam.ConnectionEndPointAugmentation1" + tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList: + allOf: + - type: "object" + properties: + connection-end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" + description: "none" + tapi.connectivity.createconnectivityservice.Input: + type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.createconnectivityservice.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityService" + tapi.connectivity.deleteconnectivityservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.getconnectiondetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.getconnectiondetails.Output: + type: "object" + properties: + connection: + description: "none" + $ref: "#/definitions/tapi.connectivity.Connection" + tapi.connectivity.getconnectionendpointdetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.getconnectionendpointdetails.Output: + type: "object" + properties: + connection-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" + tapi.connectivity.getconnectivityservicedetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.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: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.updateconnectivityservice.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityService" + tapi.notification.ContextAugmentation2: + type: "object" + properties: + notification-context: + description: "Augments the base TAPI Context with NotificationService information" + $ref: "#/definitions/tapi.notification.context.NotificationContext" + x-augmentation: + prefix: "tapi-notification" + namespace: "urn:onf:otcc:yang:tapi-notification" + tapi.notification.CreateNotificationSubscriptionService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Output" + tapi.notification.GetNotificationList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationlist.Output" + tapi.notification.GetNotificationSubscriptionServiceDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Output" + tapi.notification.GetNotificationSubscriptionServiceList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicelist.Output" + tapi.notification.GetSupportedNotificationTypes: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getsupportednotificationtypes.Output" + tapi.notification.NameAndValueChange: + type: "object" + properties: + value-name: + type: "string" + description: "The name of the value. The value need not have a name." + old-value: + type: "string" + description: "The value" + new-value: + type: "string" + description: "The value" + tapi.notification.Notification: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + target-object-type: + type: "string" + description: "none" + additional-text: + type: "string" + description: "none" + event-time-stamp: + type: "string" + description: "none" + additional-info: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.NameAndValue" + sequence-number: + type: "integer" + format: "int32" + description: "A monotonous increasing sequence number associated with the\ + \ notification.\r\n The exact semantics of how this sequence\ + \ number is assigned (per channel or subscription or source or system)\ + \ is left undefined." + target-object-identifier: + type: "string" + description: "none" + notification-type: + type: "string" + description: "none" + target-object-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.NameAndValue" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + source-indicator: + description: "none" + $ref: "#/definitions/tapi.notification.SourceIndicator" + layer-protocol-qualifier: + type: "string" + description: "none" + changed-attributes: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + description: "none" + tapi.notification.NotificationChannel: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + next-sequence-no: + type: "integer" + format: "int32" + description: "The sequence number of the next notification that will be\ + \ published on the channel" + stream-address: + type: "string" + description: "The address/location/URI of the channel/stream to which the\ + \ subscribed notifications are published.\r\n This specifics\ + \ of this is typically dependent on the implementation protocol & mechanism\ + \ and hence is typed as a string." + description: "none" + tapi.notification.NotificationSubscriptionService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.Notification" + notification-channel: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationChannel" + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + supported-object-types: + type: "array" + description: "none" + items: + type: "string" + supported-notification-types: + type: "array" + description: "none" + items: + type: "string" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + description: "none" + tapi.notification.SourceIndicator: + type: "string" + enum: + - "RESOURCE_OPERATION" + - "MANAGEMENT_OPERATION" + - "UNKNOWN" + tapi.notification.SubscriptionFilter: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + requested-notification-types: + type: "array" + description: "none" + items: + type: "string" + requested-object-identifier: + type: "array" + description: "none" + items: + type: "string" + requested-layer-protocols: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + include-content: + type: "boolean" + description: "Indicates whether the published Notification includes content\ + \ or just the Notification Id (which enables retrieval of the notification\ + \ at the later stage)" + default: false + requested-object-types: + type: "array" + description: "none" + items: + type: "string" + description: "none" + tapi.notification.SubscriptionState: + type: "string" + enum: + - "SUSPENDED" + - "ACTIVE" + tapi.notification.UpdateNotificationSubscriptionService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Output" + tapi.notification.context.NotificationContext: + allOf: + - type: "object" + properties: + notif-subscription: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" + description: "Augments the base TAPI Context with NotificationService information" + tapi.notification.createnotificationsubscriptionservice.Input: + type: "object" + properties: + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + tapi.notification.createnotificationsubscriptionservice.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.deletenotificationsubscriptionservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationlist.Input: + type: "object" + properties: + time-range: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + subscription-id: + type: "string" + description: "UUID of the associated Notification Subscription Service: An\ + \ identifier that is universally unique within an identifier space, where\ + \ the identifier space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationlist.Output: + type: "object" + properties: + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" + tapi.notification.getnotificationsubscriptionservicedetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationsubscriptionservicedetails.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.getnotificationsubscriptionservicelist.Output: + type: "object" + properties: + subscription-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.getsupportednotificationtypes.Output: + type: "object" + properties: + supported-object-types: + type: "array" + description: "none" + items: + type: "string" + supported-notification-types: + type: "array" + description: "none" + items: + type: "string" + tapi.notification.notificationcontext.Notification: + allOf: + - $ref: "#/definitions/tapi.notification.Notification" + - $ref: "#/definitions/tapi.oam.NotificationAugmentation1" + - $ref: "#/definitions/tapi.oam.NotificationAugmentation2" + tapi.notification.updatenotificationsubscriptionservice.Input: + type: "object" + properties: + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + tapi.notification.updatenotificationsubscriptionservice.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.oam.AlarmInfo: + type: "object" + properties: + perceived-severity: + description: "none" + $ref: "#/definitions/tapi.oam.PerceivedSeverityType" + probable-cause: + type: "string" + description: "none" + service-affecting: + description: "none" + $ref: "#/definitions/tapi.oam.ServiceAffecting" + is-transient: + type: "boolean" + description: "none" + default: false + tapi.oam.ConnectionEndPointAugmentation1: + type: "object" + properties: + mep-mip-list: + description: "none" + $ref: "#/definitions/tapi.oam.MepMipList" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" + tapi.oam.ContextAugmentation3: + type: "object" + properties: + oam-context: + description: "Augments the base TAPI Context with OamService information" + $ref: "#/definitions/tapi.oam.OamContext" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" + tapi.oam.CreateOamJob: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.createoamjob.Output" + tapi.oam.CreateOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.createoamprofile.Output" + tapi.oam.CreateOamService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.createoamservice.Output" + tapi.oam.CreateOamServicePoint: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.createoamservicepoint.Output" + tapi.oam.CurrentData: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + elapsed-time: + description: "none" + $ref: "#/definitions/tapi.common.TimeInterval" + period-start-time: + type: "string" + description: "This attribute indicates the start of the current monitoring\ + \ interval.\r\n The value is bound to the quarter of an\ + \ hour in case of a 15 minute interval and bound to the hour in case of\ + \ a 24 hour interval." + pm-data-pac: + description: "none" + $ref: "#/definitions/tapi.oam.PmDataPac" + history-data: + type: "array" + description: "in case of 24hr Current Data, at least 1 History Data.\r\n\ + \ In case of 15min Current Data, at least 16 History Data.\r\ + \n In case of <15min, the number of History Data shall\ + \ be able to cover a span of 4 hours." + items: + $ref: "#/definitions/tapi.oam.HistoryData" + description: "none" + tapi.oam.GetMeg: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getmeg.Output" + tapi.oam.GetOamJob: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamjob.Output" + tapi.oam.GetOamJobList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamjoblist.Output" + tapi.oam.GetOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamprofile.Output" + tapi.oam.GetOamProfileList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamprofilelist.Output" + tapi.oam.GetOamService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamservice.Output" + tapi.oam.GetOamServiceList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamservicelist.Output" + tapi.oam.GetOamServicePoint: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamservicepoint.Output" + tapi.oam.HistoryData: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + period-start-time: + type: "string" + description: "This attribute indicates the start of the monitoring interval.\r\ + \n The value is bound to the quarter of an hour in case\ + \ of a 15 minute interval and bound to the hour in case of a 24 hour interval." + pm-data-pac: + description: "none" + $ref: "#/definitions/tapi.oam.PmDataPac" + period-end-time: + type: "string" + description: "none" + description: "none" + tapi.oam.Meg: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.common.OperationalStatePac" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + mep: + type: "array" + description: "1. ME may have 0 MEPs (case of transit domains where at least\ + \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case of edge\ + \ domaind, where the peer MEP is ouside the managed domain)\r\n \ + \ 3. ME may have 2 MEPs" + items: + $ref: "#/definitions/tapi.oam.Mep" + mip: + type: "array" + description: "ME may 0, 1, or more MIPs" + items: + $ref: "#/definitions/tapi.oam.Mip" + description: "none" + tapi.oam.MegRef: + type: "object" + properties: + meg-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:uuid" + tapi.oam.Mep: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - $ref: "#/definitions/tapi.common.OperationalStatePac" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + description: "none" + tapi.oam.MepMipList: + type: "object" + properties: + mip: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.MipRef" + mep: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.MepRef" + tapi.oam.MepRef: + allOf: + - $ref: "#/definitions/tapi.oam.MegRef" + - type: "object" + properties: + mep-local-id: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:mep/tapi-oam:local-id" + description: "none" + tapi.oam.Mip: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + description: "none" + tapi.oam.MipRef: + allOf: + - $ref: "#/definitions/tapi.oam.MegRef" + - type: "object" + properties: + mip-local-id: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:mip/tapi-oam:local-id" + description: "none" + tapi.oam.NotificationAugmentation1: + type: "object" + properties: + alarm-info: + description: "none" + $ref: "#/definitions/tapi.oam.AlarmInfo" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" + tapi.oam.NotificationAugmentation2: + type: "object" + properties: + tca-info: + description: "none" + $ref: "#/definitions/tapi.oam.TcaInfo" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" + tapi.oam.OamContext: + type: "object" + properties: + oam-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamService" + oam-profile: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamProfile" + oam-job: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamJob" + meg: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.Meg" + tapi.oam.OamJob: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + schedule: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + oam-profile: + description: "none" + $ref: "#/definitions/tapi.oam.OamProfileRef" + creation-time: + type: "string" + description: "none" + oam-job-type: + type: "string" + description: "none" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamServicePointRef" + current-data: + type: "array" + description: "Granularity period of the CurrentData identifies the specific\ + \ CurrentData instance in the scope of this OamJob.\r\n \ + \ For example, typically at least\r\n one 15min and\r\n\ + \ one 24hr;\r\n optionally one additional\ + \ configurable (< 15min)" + items: + $ref: "#/definitions/tapi.oam.CurrentData" + description: "none" + tapi.oam.OamJobRef: + type: "object" + properties: + oam-job-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-job/tapi-oam:uuid" + tapi.oam.OamProfile: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + pm-threshold-data: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.PmThresholdData" + description: "none" + tapi.oam.OamProfileRef: + type: "object" + properties: + oam-profile-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-profile/tapi-oam:uuid" + tapi.oam.OamService: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamServicePoint" + meg: + description: "none" + $ref: "#/definitions/tapi.oam.MegRef" + description: "none" + tapi.oam.OamServicePoint: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + mip: + description: "none" + $ref: "#/definitions/tapi.oam.MipRef" + service-interface-point: + description: "none" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + is-mip: + type: "boolean" + description: "If true, the object is related to a MIP.\r\n \ + \ If false, the object is related to a MEP." + default: false + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + mep: + description: "none" + $ref: "#/definitions/tapi.oam.MepRef" + description: "none" + tapi.oam.OamServicePointRef: + allOf: + - $ref: "#/definitions/tapi.oam.OamServiceRef" + - type: "object" + properties: + oam-service-point-local-id: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:oam-service-point/tapi-oam:local-id" + description: "none" + tapi.oam.OamServiceRef: + type: "object" + properties: + oam-service-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:uuid" + tapi.oam.PerceivedSeverityType: + type: "string" + enum: + - "CRITICAL" + - "MAJOR" + - "MINOR" + - "WARNING" + - "CLEARED" + tapi.oam.PerceivedTcaSeverity: + type: "string" + enum: + - "WARNING" + - "CLEAR" + tapi.oam.PmDataPac: + type: "object" + properties: + suspect-interval-flag: + type: "boolean" + description: "This attribute is used to indicate that the performance data\ + \ for the current period may not be reliable. Some reasons for this to occur\ + \ are:\r\n – Suspect data were detected by the actual resource\ + \ doing data collection.\r\n – Transition of the administrativeState\ + \ attribute to/from the 'lock' state.\r\n – Transition of\ + \ the operationalState to/from the 'disabled' state.\r\n \ + \ – Scheduler setting that inhibits the collection function.\r\n \ + \ – The performance counters were reset during the interval.\r\n\ + \ – The currentData (or subclass) object instance was created\ + \ during the monitoring period." + default: false + granularity-period: + description: "none" + $ref: "#/definitions/tapi.common.TimePeriod" + tapi.oam.PmParameterValue: + type: "object" + properties: + pm-parameter-int-value: + type: "integer" + format: "int32" + description: "none" + pm-parameter-real-value: + type: "string" + description: "none" + tapi.oam.PmThresholdData: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + granularity-period: + description: "none" + $ref: "#/definitions/tapi.common.TimePeriod" + threshold-parameter: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.ThresholdParameter" + is-transient: + type: "boolean" + description: "none" + default: false + applicable-job-type: + type: "array" + description: "This attribute allows an PMThresholdData instance to be constrained\ + \ to specific job types. If an PMThresholdData instance is so configured\ + \ to be applicable to more than one job type (worst case ALL), only the\ + \ parameters relevant for the job instance will be used (non-applicable\ + \ profile parameters will be ignored)" + items: + type: "string" + description: "none" + tapi.oam.ServiceAffecting: + type: "string" + enum: + - "SERVICE_AFFECTING" + - "NOT_SERVICE_AFFECTING" + - "UNKNOWN" + tapi.oam.TcaInfo: + type: "object" + properties: + oam-job: + description: "MEF 35.1\r\n Identification of the PM Session\ + \ for which the TCA Function was configured." + $ref: "#/definitions/tapi.oam.OamJobRef" + threshold-parameter: + description: "none" + $ref: "#/definitions/tapi.oam.ThresholdParameter" + is-transient: + type: "boolean" + description: "none" + default: false + perceived-severity: + description: "none" + $ref: "#/definitions/tapi.oam.PerceivedTcaSeverity" + suspect-interval-flag: + type: "boolean" + description: "none" + default: false + measurement-interval: + type: "string" + description: "none" + tapi.oam.ThresholdCrossingQualifier: + type: "string" + enum: + - "NOT_APPLICABLE" + - "NEAR_END" + - "FAR_END" + - "BIDIRECTIONAL" + - "FORWARD" + - "BACKWARD" + tapi.oam.ThresholdParameter: + type: "object" + properties: + pm-parameter-below-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-clear-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-above-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-name: + type: "string" + description: "none" + threshold-location: + description: "none" + $ref: "#/definitions/tapi.oam.ThresholdCrossingQualifier" + tapi.oam.UpdateOamJob: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.updateoamjob.Output" + tapi.oam.UpdateOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.updateoamprofile.Output" + tapi.oam.UpdateOamService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.updateoamservice.Output" + tapi.oam.UpdateOamServicePoint: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.updateoamservicepoint.Output" + tapi.oam.createoamjob.Input: + type: "object" + properties: + schedule: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point-id: + type: "string" + description: "UUID of the associated OSEPs: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + oam-job-type: + type: "string" + description: "none" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + oam-profile-id: + type: "string" + description: "UUID of the OamProfile to be applied: An identifier that is\ + \ universally unique within an identifier space, where the identifier space\ + \ is itself globally unique, and immutable.\r\n An UUID\ + \ carries no semantics with respect to the purpose or state of the entity.\r\ + \n UUID here uses string representation as defined in\ + \ RFC 4122. The canonical representation uses lowercase characters.\r\n\ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + oam-service-id: + type: "string" + description: "UUID of the associated OamService: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.createoamjob.Output: + type: "object" + properties: + oam-job: + description: "none" + $ref: "#/definitions/tapi.oam.OamJob" + tapi.oam.createoamprofile.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + pm-threshold-data: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.PmThresholdData" + tapi.oam.createoamprofile.Output: + type: "object" + properties: + oam-profile: + description: "none" + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.createoamservice.Input: + type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamServicePoint" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.createoamservice.Output: + type: "object" + properties: + oam-service: + description: "none" + $ref: "#/definitions/tapi.oam.OamService" + tapi.oam.createoamservicepoint.Input: + type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + connectivity-service-end-point-id: + type: "string" + description: "UUID of the CSEP to be monitored: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + service-interface-point-id: + type: "string" + description: "UUID of the associated SIP to be monitored: An identifier that\ + \ is universally unique within an identifier space, where the identifier\ + \ space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose or state of\ + \ the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + oam-service-id: + type: "string" + description: "UUID of the parent OamService: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.createoamservicepoint.Output: + type: "object" + properties: + oam-service-point: + description: "none" + $ref: "#/definitions/tapi.oam.OamServicePoint" + tapi.oam.deleteoamjob.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamprofile.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamservicepoint.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getmeg.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getmeg.Output: + type: "object" + properties: + meg: + description: "none" + $ref: "#/definitions/tapi.oam.Meg" + tapi.oam.getoamjob.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamjob.Output: + type: "object" + properties: + oam-job: + description: "none" + $ref: "#/definitions/tapi.oam.OamJob" + tapi.oam.getoamjoblist.Output: + type: "object" + properties: + oam-job: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamJob" + tapi.oam.getoamprofile.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamprofile.Output: + type: "object" + properties: + oam-profile: + description: "none" + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.getoamprofilelist.Output: + type: "object" + properties: + oam-profile: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.getoamservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamservice.Output: + type: "object" + properties: + oam-service: + description: "none" + $ref: "#/definitions/tapi.oam.OamService" + tapi.oam.getoamservicelist.Output: + type: "object" + properties: + oam-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamService" + tapi.oam.getoamservicepoint.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamservicepoint.Output: + type: "object" + properties: + oam-service-point: + description: "none" + $ref: "#/definitions/tapi.oam.OamServicePoint" + tapi.oam.updateoamjob.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + schedule: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + oam-profile-id: + type: "string" + description: "UUID of the OamProfile to be applied: An identifier that is\ + \ universally unique within an identifier space, where the identifier space\ + \ is itself globally unique, and immutable.\r\n An UUID\ + \ carries no semantics with respect to the purpose or state of the entity.\r\ + \n UUID here uses string representation as defined in\ + \ RFC 4122. The canonical representation uses lowercase characters.\r\n\ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.updateoamjob.Output: + type: "object" + properties: + oam-job: + description: "none" + $ref: "#/definitions/tapi.oam.OamJob" + tapi.oam.updateoamprofile.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + pm-threshold-data: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.PmThresholdData" + tapi.oam.updateoamprofile.Output: + type: "object" + properties: + oam-profile: + description: "none" + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.updateoamservice.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamServicePoint" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.updateoamservice.Output: + type: "object" + properties: + oam-service: + description: "none" + $ref: "#/definitions/tapi.oam.OamService" + tapi.oam.updateoamservicepoint.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.updateoamservicepoint.Output: + type: "object" + properties: + oam-service-point: + description: "none" + $ref: "#/definitions/tapi.oam.OamServicePoint" + tapi.path.computation.ComputeP2PPath: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.path.computation.computep2ppath.Output" + tapi.path.computation.ContextAugmentation1: + 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.PathComputationService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $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" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + optimization-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "none" + tapi.path.computation.PathObjectiveFunction: + allOf: + - $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.PathOptimizationConstraint: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + traffic-interruption: + description: "none" + $ref: "#/definitions/tapi.common.DirectiveValue" + description: "none" + 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.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.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 + tolerable-impact: + type: "string" + description: "Grades of maximum tolerable disruption to traffic." + 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" + 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" + tapi.path.computation.TopologyConstraint: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + include-node: + type: "string" + description: "This is a loose constraint - that is it is unordered and could\ + \ be a partial list" + exclude-link: + type: "string" + description: "none" + avoid-topology: + type: "string" + description: "none" + exclude-path: + type: "string" + description: "none" + include-topology: + type: "string" + description: "none" + include-path: + type: "string" + description: "none" + exclude-node-edge-point: + type: "string" + description: "none" + include-node-edge-point: + type: "string" + description: "none" + include-link: + type: "string" + description: "This is a loose constraint - that is it is unordered and could\ + \ be a partial list " + preferred-transport-layer: + description: "soft constraint requested by client to indicate the layer(s)\ + \ of transport connection that it prefers to carry the service. This could\ + \ be same as the service layer or one of the supported server layers" + $ref: "#/definitions/tapi.common.LayerProtocolName" + exclude-node: + type: "string" + description: "none" + constraint-weight: + type: "integer" + format: "int32" + description: "Zero and positive values: zero means 'strongly required to\ + \ be included', +1 means 'less strongly required to be included', etc.\r\ + \n For example the work/intended route will be calculated\ + \ considering the topologies which weights are lowest (but not negative).\r\ + \n Negative values: -1 means 'strongly required to be excluded',\ + \ -2 means 'less strongly required to be excluded', etc." + description: "The TopologyConstraint allows to specify topology entities in\ + \ order to impose specific constraints (as denoted by the attribute name)\ + \ on Connectivity/Path.\r\n The topology entities are specified\ + \ by their instance uuid rather than using references/path (to allow for mapping\ + \ to Yang 1.0).\r\n This loose typing and reference necessitates\ + \ that implementations validate not only the presence of the instance, but\ + \ also that it is of the correct type as implied by the attribute name.\r\n\ + \ If this validation fails, then the implementation is expceted\ + \ to return an error.\r\n " + tapi.path.computation.computep2ppath.Input: + type: "object" + properties: + topology-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + objective-function: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.path.computation.computep2ppath.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathComputationService" + tapi.path.computation.deletep2ppath.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.path.computation.deletep2ppath.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathComputationService" + tapi.path.computation.optimizep2ppath.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + optimization-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + objective-function: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + tapi.path.computation.optimizep2ppath.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathComputationService" + tapi.topology.ContextAugmentation5: + type: "object" + properties: + topology-context: + description: "Augments the base TAPI Context with TopologyService information" + $ref: "#/definitions/tapi.topology.TopologyContext" + x-augmentation: + prefix: "tapi-topology" + namespace: "urn:onf:otcc:yang:tapi-topology" + tapi.topology.CostCharacteristic: + type: "object" + properties: + cost-value: + type: "string" + description: "The specific cost." + cost-algorithm: + type: "string" + description: "The cost may vary based upon some properties of the TopologicalEntity.\ + \ The rules for the variation are conveyed by the costAlgorithm." + cost-name: + type: "string" + description: "The cost characteristic will related to some aspect of the TopologicalEntity\ + \ (e.g. $ cost, routing weight). This aspect will be conveyed by the costName." + tapi.topology.ForwardingRule: + type: "string" + enum: + - "MAY_FORWARD_ACROSS_GROUP" + - "MUST_FORWARD_ACROSS_GROUP" + - "CANNOT_FORWARD_ACROSS_GROUP" + - "NO_STATEMENT_ON_FORWARDING" + tapi.topology.GetLinkDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getlinkdetails.Output" + tapi.topology.GetNodeDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getnodedetails.Output" + tapi.topology.GetNodeEdgePointDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Output" + tapi.topology.GetTopologyDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.gettopologydetails.Output" + tapi.topology.GetTopologyList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.gettopologylist.Output" + tapi.topology.InterRuleGroup: + allOf: + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + associated-node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + rule: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Rule" + description: "none" + tapi.topology.LatencyCharacteristic: + type: "object" + properties: + traffic-property-name: + type: "string" + description: "The identifier of the specific traffic property to which the\ + \ queuing latency applies." + jitter-characteristic: + type: "string" + description: "High frequency deviation from true periodicity of a signal and\ + \ therefore a small high rate of change of transfer latency.\r\n \ + \ Applies to TDM systems (and not packet)." + fixed-latency-characteristic: + type: "string" + description: "A TopologicalEntity suffers delay caused by the realization\ + \ of the servers (e.g. distance related; FEC encoding etc.) along with some\ + \ client specific processing. This is the total average latency effect of\ + \ the TopologicalEntity" + wander-characteristic: + type: "string" + description: "Low frequency deviation from true periodicity of a signal and\ + \ therefore a small low rate of change of transfer latency.\r\n \ + \ Applies to TDM systems (and not packet)." + queing-latency-characteristic: + type: "string" + description: "The specific queuing latency for the traffic property." + tapi.topology.LayerProtocolTransitionPac: + type: "object" + properties: + transitioned-layer-protocol-name: + type: "array" + description: "Provides the ordered structure of layer protocol transitions\ + \ encapsulated in the TopologicalEntity. The ordering relates to the LinkPort\ + \ role." + items: + type: "string" + tapi.topology.Link: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.LayerProtocolTransitionPac" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - $ref: "#/definitions/tapi.topology.ValidationPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + restoration-policy: + description: "none" + $ref: "#/definitions/tapi.topology.RestorationPolicy" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" + direction: + description: "The directionality of the Link. \r\n Is applicable\ + \ to simple Links where all LinkEnds are BIDIRECTIONAL (the Link will\ + \ be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ + \ \r\n Is not present in more complex cases." + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "The Link object class models effective adjacency between two or\ + \ more ForwardingDomains (FD). " + tapi.topology.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.NepLayerProtocolCapability: + type: "object" + properties: + layer-protocol-qualifier: + type: "string" + description: "none" + number-of-cep-instances: + type: "integer" + format: "int32" + description: "none" + tapi.topology.NetworkTopologyService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.TopologyRef" + description: "none" + tapi.topology.Node: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + encap-topology: + description: "none" + $ref: "#/definitions/tapi.topology.TopologyRef" + node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePoint" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ + \ topological component which is used to effect forwarding of transport characteristic\ + \ information and offers the potential to enable forwarding. \r\n \ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ multiple switch matrices (FDs). " + tapi.topology.NodeEdgePoint: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.common.TerminationPac" + - type: "object" + properties: + link-port-role: + description: "Each LinkEnd of the Link has a role (e.g., symmetric, hub,\ + \ spoke, leaf, root) in the context of the Link with respect to the Link\ + \ function. " + $ref: "#/definitions/tapi.common.PortRole" + mapped-service-interface-point: + type: "array" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load\ + \ balancing/Resilience) should be considered experimental" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + available-cep-layer-protocol: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + link-port-direction: + description: "The orientation of defined flow at the LinkEnd." + $ref: "#/definitions/tapi.common.PortDirection" + description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ + \ termination and adaptation functions of one or more transport layers. \r\ + \n The structure of LTP supports all transport protocols including\ + \ circuit and packet forms." + tapi.topology.NodeEdgePointRef: + allOf: + - $ref: "#/definitions/tapi.topology.NodeRef" + - type: "object" + properties: + node-edge-point-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-edge-point/tapi-topology:uuid" + description: "none" + tapi.topology.NodeRef: + allOf: + - $ref: "#/definitions/tapi.topology.TopologyRef" + - type: "object" + properties: + node-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:uuid" + description: "none" + tapi.topology.NodeRuleGroup: + allOf: + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + inter-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.InterRuleGroup" + rule: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Rule" + composed-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "none" + tapi.topology.NodeRuleGroupRef: + allOf: + - $ref: "#/definitions/tapi.topology.NodeRef" + - type: "object" + properties: + node-rule-group-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-rule-group/tapi-topology:uuid" + description: "none" + tapi.topology.ProtectionType: + type: "string" + enum: + - "NO_PROTECTION" + - "ONE_PLUS_ONE_PROTECTION" + - "ONE_FOR_ONE_PROTECTION" + - "ONE_FOR_N_PROTECTION" + - "M_FOR_N_PROTECTION" + - "ONE_FOR_ONE_BY_N" + tapi.topology.RestorationPolicy: + type: "string" + enum: + - "PER_DOMAIN_RESTORATION" + - "END_TO_END_RESTORATION" + - "NA" + - "DYNAMIC_RESTORATION" + - "PRE_COMPUTED_RESTORATION" + tapi.topology.RiskCharacteristic: + type: "object" + properties: + risk-characteristic-name: + type: "string" + description: "The name of the risk characteristic. The characteristic may\ + \ be related to a specific degree of closeness. \r\n For\ + \ example a particular characteristic may apply to failures that are localized\ + \ (e.g. to one side of a road) where as another characteristic may relate\ + \ to failures that have a broader impact (e.g. both sides of a road that\ + \ crosses a bridge).\r\n Depending upon the importance of\ + \ the traffic being routed different risk characteristics will be evaluated." + risk-identifier-list: + type: "array" + description: "A list of the identifiers of each physical/geographic unit (with\ + \ the specific risk characteristic) that is related to a segment of the\ + \ TopologicalEntity." + items: + type: "string" + tapi.topology.RiskParameterPac: + type: "object" + properties: + risk-characteristic: + type: "array" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + items: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + tapi.topology.Rule: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + override-priority: + type: "integer" + format: "int32" + description: "none" + forwarding-rule: + description: "none" + $ref: "#/definitions/tapi.topology.ForwardingRule" + rule-type: + description: "none" + $ref: "#/definitions/tapi.topology.RuleType" + description: "none" + tapi.topology.RuleType: + type: "string" + enum: + - "FORWARDING" + - "CAPACITY" + - "COST" + - "TIMING" + - "RISK" + - "GROUPING" + tapi.topology.Topology: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + link: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Link" + node: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Node" + boundary-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ + \ topological component which is used to effect forwarding of transport characteristic\ + \ information and offers the potential to enable forwarding. \r\n \ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ multiple switch matrices (FDs). " + tapi.topology.TopologyContext: + type: "object" + properties: + nw-topology-service: + description: "none" + $ref: "#/definitions/tapi.topology.NetworkTopologyService" + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.TopologyRef: + type: "object" + properties: + topology-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:uuid" + tapi.topology.TransferCostPac: + type: "object" + properties: + cost-characteristic: + type: "array" + description: "The list of costs where each cost relates to some aspect of\ + \ the TopologicalEntity." + items: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + tapi.topology.TransferIntegrityPac: + type: "object" + properties: + error-characteristic: + type: "string" + description: "Describes the degree to which the signal propagated can be errored.\ + \ \r\n Applies to TDM systems as the errored signal will\ + \ be propagated and not packet as errored packets will be discarded." + unavailable-time-characteristic: + type: "string" + description: "Describes the duration for which there may be no valid signal\ + \ propagated." + server-integrity-process-characteristic: + type: "string" + description: "Describes the effect of any server integrity enhancement process\ + \ on the characteristics of the TopologicalEntity." + delivery-order-characteristic: + type: "string" + description: "Describes the degree to which packets will be delivered out\ + \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ + \ maintain strict order." + repeat-delivery-characteristic: + type: "string" + description: "Primarily applies to packet systems where a packet may be delivered\ + \ more than once (in fault recovery for example). \r\n It\ + \ can also apply to TDM where several frames may be received twice due to\ + \ switching in a system with a large differential propagation delay." + loss-characteristic: + type: "string" + description: "Describes the acceptable characteristic of lost packets where\ + \ loss may result from discard due to errors or overflow.\r\n \ + \ Applies to packet systems and not TDM (as for TDM errored signals\ + \ are propagated unless grossly errored and overflow/underflow turns into\ + \ timing slips)." + tapi.topology.TransferTimingPac: + type: "object" + properties: + latency-characteristic: + type: "array" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + items: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + tapi.topology.ValidationMechanism: + type: "object" + properties: + layer-protocol-adjacency-validated: + type: "string" + description: "State of validatiion" + validation-mechanism: + type: "string" + description: "Name of mechanism used to validate adjacency" + validation-robustness: + type: "string" + description: "Quality of validation (i.e. how likely is the stated validation\ + \ to be invalid)" + tapi.topology.ValidationPac: + type: "object" + properties: + validation-mechanism: + type: "array" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." + items: + $ref: "#/definitions/tapi.topology.ValidationMechanism" + tapi.topology.getlinkdetails.Input: + type: "object" + properties: + link-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getlinkdetails.Output: + type: "object" + properties: + link: + description: "none" + $ref: "#/definitions/tapi.topology.Link" + tapi.topology.getnodedetails.Input: + type: "object" + properties: + node-id: + type: "string" + description: "UUID of the Node: An identifier that is universally unique within\ + \ an identifier space, where the identifier space is itself globally unique,\ + \ and immutable.\r\n An UUID carries no semantics with\ + \ respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The canonical\ + \ representation uses lowercase characters.\r\n Pattern:\ + \ [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getnodedetails.Output: + type: "object" + properties: + node: + description: "none" + $ref: "#/definitions/tapi.topology.Node" + tapi.topology.getnodeedgepointdetails.Input: + type: "object" + properties: + node-id: + type: "string" + description: "UUID of the parent Node: An identifier that is universally unique\ + \ within an identifier space, where the identifier space is itself globally\ + \ unique, and immutable.\r\n An UUID carries no semantics\ + \ with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The\ + \ canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Node's Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + node-edge-point-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getnodeedgepointdetails.Output: + type: "object" + properties: + node-edge-point: + description: "none" + $ref: "#/definitions/tapi.topology.NodeEdgePoint" + tapi.topology.gettopologydetails.Input: + type: "object" + properties: + topology-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.gettopologydetails.Output: + type: "object" + properties: + topology: + description: "none" + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.gettopologylist.Output: + type: "object" + properties: + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.node.NodeEdgePoint: + allOf: + - $ref: "#/definitions/tapi.connectivity.NodeEdgePointAugmentation1" + - $ref: "#/definitions/tapi.topology.NodeEdgePoint" + tapi.topology.topology.Node: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + encap-topology: + description: "none" + $ref: "#/definitions/tapi.topology.TopologyRef" + node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.node.NodeEdgePoint" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "none" diff --git a/OAS/tapi-equipment@2019-03-31.yaml b/OAS/tapi-equipment@2019-03-31.yaml new file mode 100644 index 00000000..e9b7b9ae --- /dev/null +++ b/OAS/tapi-equipment@2019-03-31.yaml @@ -0,0 +1,6624 @@ +--- +swagger: "2.0" +info: + description: "\r\n This module contains TAPI Notification Model definitions.\r\ + \n Source: TapiNotification.uml\r\n Copyright (c) 2018 Open Networking\ + \ Foundation (ONF). All rights reserved.\r\n License: This module is distributed\ + \ under the Apache License 2.0\r\n - The TAPI YANG models included in this\ + \ TAPI release are a *normative* part of the TAPI SDK.\r\n - The YANG specifications\ + \ have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG\ + \ mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Topology\ + \ Model definitions.\r\n Source: TapiTopology.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n - The TAPI YANG models included in\ + \ this TAPI release are a *normative* part of the TAPI SDK.\r\n - The YANG\ + \ specifications have been generated from the corresponding UML model using the\ + \ [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Common Model\ + \ definitions.\r\n Source: TapiCommon.uml\r\n Copyright (c) 2018\ + \ Open Networking Foundation (ONF). All rights reserved.\r\n License: This\ + \ module is distributed under the Apache License 2.0\r\n - The TAPI YANG\ + \ models included in this TAPI release are a *normative* part of the TAPI SDK.\r\ + \n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases." + version: "2.2.0" + title: "tapi-notification,tapi-topology,tapi-equipment,tapi-common API" +host: "localhost:1234" +consumes: +- "application/yang-data+json" +produces: +- "application/yang-data+json" +paths: + /data/context/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Context" + description: "none" + parameters: [] + responses: + 200: + description: "tapi.common.Context" + schema: + $ref: "#/definitions/tapi.common.Context" + 400: + description: "Internal error" + post: + tags: + - "tapi-common" + summary: "creates tapi.common.Context" + description: "none" + parameters: + - in: "body" + name: "tapi.common.Context.body-param" + description: "tapi.common.Context to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.Context" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.Context" + description: "none" + parameters: + - in: "body" + name: "tapi.common.Context.body-param" + description: "tapi.common.Context to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.Context" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.Context" + description: "none" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/name/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] + responses: + 200: + description: "tapi.notification.NotificationContext" + schema: + $ref: "#/definitions/tapi.notification.NotificationContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: + - in: "body" + name: "tapi.notification.NotificationContext.body-param" + description: "tapi.notification.NotificationContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: + - in: "body" + name: "tapi.notification.NotificationContext.body-param" + description: "tapi.notification.NotificationContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - in: "body" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NotificationSubscriptionService" + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/name/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/notification-channel/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationChannel" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NotificationChannel" + schema: + $ref: "#/definitions/tapi.notification.NotificationChannel" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.Notification" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.Notification" + schema: + $ref: "#/definitions/tapi.notification.Notification" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.SubscriptionFilter" + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + 400: + description: "Internal error" + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notification={uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.Notification" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.Notification" + schema: + $ref: "#/definitions/tapi.notification.Notification" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/additional-info={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/physical-context/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.PhysicalContext" + description: "none" + parameters: [] + responses: + 200: + description: "tapi.equipment.PhysicalContext" + schema: + $ref: "#/definitions/tapi.equipment.PhysicalContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-equipment" + summary: "creates tapi.equipment.PhysicalContext" + description: "none" + parameters: + - in: "body" + name: "tapi.equipment.PhysicalContext.body-param" + description: "tapi.equipment.PhysicalContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.equipment.PhysicalContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-equipment" + summary: "creates or updates tapi.equipment.PhysicalContext" + description: "none" + parameters: + - in: "body" + name: "tapi.equipment.PhysicalContext.body-param" + description: "tapi.equipment.PhysicalContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.equipment.PhysicalContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-equipment" + summary: "removes tapi.equipment.PhysicalContext" + description: "none" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/physical-context/device={uuid}/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.Device" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.Device" + schema: + $ref: "#/definitions/tapi.equipment.Device" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/access-port={access-port-uuid}/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.AccessPort" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "access-port-uuid" + in: "path" + description: "Id of access-port" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.AccessPort" + schema: + $ref: "#/definitions/tapi.equipment.AccessPort" + 400: + description: "Internal error" + ? /data/context/physical-context/device={uuid}/access-port={access-port-uuid}/connector-pin={connector-identification},{pin-identification},{equipment-uuid}/ + : get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.ConnectorPinAddress" + description: "The list of Pins that support the AccessPort." + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "access-port-uuid" + in: "path" + description: "Id of access-port" + required: true + type: "string" + - name: "connector-identification" + in: "path" + description: "Id of connector-pin" + required: true + type: "string" + - name: "pin-identification" + in: "path" + description: "Id of connector-pin" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of connector-pin" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.ConnectorPinAddress" + schema: + $ref: "#/definitions/tapi.equipment.ConnectorPinAddress" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/access-port={access-port-uuid}/name={value-name}/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "access-port-uuid" + in: "path" + description: "Id of access-port" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.Equipment" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.Equipment" + schema: + $ref: "#/definitions/tapi.equipment.Equipment" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/actual-equipment/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.ActualEquipment" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.ActualEquipment" + schema: + $ref: "#/definitions/tapi.equipment.ActualEquipment" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/actual-equipment/actual-non-field-replaceable-module/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.ActualNonFieldReplaceableModule" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.ActualNonFieldReplaceableModule" + schema: + $ref: "#/definitions/tapi.equipment.ActualNonFieldReplaceableModule" + 400: + description: "Internal error" + ? /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/actual-equipment/actual-non-field-replaceable-module/common-actual-properties/ + : get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.CommonActualProperties" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.CommonActualProperties" + schema: + $ref: "#/definitions/tapi.equipment.CommonActualProperties" + 400: + description: "Internal error" + ? /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/actual-equipment/actual-non-field-replaceable-module/common-equipment-properties/ + : get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.CommonEquipmentProperties" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.CommonEquipmentProperties" + schema: + $ref: "#/definitions/tapi.equipment.CommonEquipmentProperties" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/actual-equipment/common-actual-properties/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.CommonActualProperties" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.CommonActualProperties" + schema: + $ref: "#/definitions/tapi.equipment.CommonActualProperties" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/actual-equipment/common-equipment-properties/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.CommonEquipmentProperties" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.CommonEquipmentProperties" + schema: + $ref: "#/definitions/tapi.equipment.CommonEquipmentProperties" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/contained-holder={contained-holder-uuid}/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.Holder" + description: "References the Holder in an Equipment that is available to take\ + \ other Equipments.\r\n For example:\r\n - Slot\ + \ in a sub-rack\r\n - Slot in a Field Replaceable Unit that\ + \ can take a small form-factor pluggable." + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + - name: "contained-holder-uuid" + in: "path" + description: "Id of contained-holder" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.Holder" + schema: + $ref: "#/definitions/tapi.equipment.Holder" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/contained-holder={contained-holder-uuid}/actual-holder/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.ActualHolder" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + - name: "contained-holder-uuid" + in: "path" + description: "Id of contained-holder" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.ActualHolder" + schema: + $ref: "#/definitions/tapi.equipment.ActualHolder" + 400: + description: "Internal error" + ? /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/contained-holder={contained-holder-uuid}/actual-holder/common-holder-properties/ + : get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.CommonHolderProperties" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + - name: "contained-holder-uuid" + in: "path" + description: "Id of contained-holder" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.CommonHolderProperties" + schema: + $ref: "#/definitions/tapi.equipment.CommonHolderProperties" + 400: + description: "Internal error" + ? /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/contained-holder={contained-holder-uuid}/expected-holder/ + : get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.ExpectedHolder" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + - name: "contained-holder-uuid" + in: "path" + description: "Id of contained-holder" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.ExpectedHolder" + schema: + $ref: "#/definitions/tapi.equipment.ExpectedHolder" + 400: + description: "Internal error" + ? /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/contained-holder={contained-holder-uuid}/expected-holder/common-holder-properties/ + : get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.CommonHolderProperties" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + - name: "contained-holder-uuid" + in: "path" + description: "Id of contained-holder" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.CommonHolderProperties" + schema: + $ref: "#/definitions/tapi.equipment.CommonHolderProperties" + 400: + description: "Internal error" + ? /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/contained-holder={contained-holder-uuid}/name={value-name}/ + : get: + tags: + - "tapi-equipment" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + - name: "contained-holder-uuid" + in: "path" + description: "Id of contained-holder" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/contained-holder={contained-holder-uuid}/occupying-fru/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.EquipmentRef" + description: "The FRU that is occupying the holder. \r\n A holder\ + \ may be unoccupied. \r\n An FRU may occupy more hat one holder\ + \ (using or blocking are intentionally not distinguished here)." + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + - name: "contained-holder-uuid" + in: "path" + description: "Id of contained-holder" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.EquipmentRef" + schema: + $ref: "#/definitions/tapi.equipment.EquipmentRef" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/expected-equipment/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.ExpectedEquipment" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.ExpectedEquipment" + schema: + $ref: "#/definitions/tapi.equipment.ExpectedEquipment" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/expected-equipment/common-equipment-properties/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.CommonEquipmentProperties" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.CommonEquipmentProperties" + schema: + $ref: "#/definitions/tapi.equipment.CommonEquipmentProperties" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/expected-equipment/expected-holder/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.ExpectedHolder" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.ExpectedHolder" + schema: + $ref: "#/definitions/tapi.equipment.ExpectedHolder" + 400: + description: "Internal error" + ? /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/expected-equipment/expected-holder/common-holder-properties/ + : get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.CommonHolderProperties" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.CommonHolderProperties" + schema: + $ref: "#/definitions/tapi.equipment.CommonHolderProperties" + 400: + description: "Internal error" + ? /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/expected-equipment/expected-non-field-replaceable-module/ + : get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.ExpectedNonFieldReplaceableModule" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.ExpectedNonFieldReplaceableModule" + schema: + $ref: "#/definitions/tapi.equipment.ExpectedNonFieldReplaceableModule" + 400: + description: "Internal error" + ? /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/expected-equipment/expected-non-field-replaceable-module/common-equipment-properties/ + : get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.CommonEquipmentProperties" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.CommonEquipmentProperties" + schema: + $ref: "#/definitions/tapi.equipment.CommonEquipmentProperties" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/equipment={equipment-uuid}/name={value-name}/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of equipment" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/physical-context/device={uuid}/name={value-name}/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of device" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/physical-context/name/: + post: + tags: + - "tapi-equipment" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/physical-context/name={value-name}/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-equipment" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-equipment" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/physical-context/physical-span={uuid}/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.PhysicalSpan" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of physical-span" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.PhysicalSpan" + schema: + $ref: "#/definitions/tapi.equipment.PhysicalSpan" + 400: + description: "Internal error" + /data/context/physical-context/physical-span={uuid}/abstract-strand={local-id}/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.AbstractStrand" + description: "Both the serial segments that form an end-end strand and the parallel\ + \ end-end strands." + parameters: + - name: "uuid" + in: "path" + description: "Id of physical-span" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of abstract-strand" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.AbstractStrand" + schema: + $ref: "#/definitions/tapi.equipment.AbstractStrand" + 400: + description: "Internal error" + ? /data/context/physical-context/physical-span={uuid}/abstract-strand={local-id}/adjacent-strand={physical-span-uuid},{abstract-strand-local-id}/ + : get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.AbstractStrandRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of physical-span" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of abstract-strand" + required: true + type: "string" + - name: "physical-span-uuid" + in: "path" + description: "Id of adjacent-strand" + required: true + type: "string" + - name: "abstract-strand-local-id" + in: "path" + description: "Id of adjacent-strand" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.AbstractStrandRef" + schema: + $ref: "#/definitions/tapi.equipment.AbstractStrandRef" + 400: + description: "Internal error" + ? /data/context/physical-context/physical-span={uuid}/abstract-strand={local-id}/connector-pin={connector-identification},{pin-identification},{equipment-uuid}/ + : get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.ConnectorPinAddress" + description: "A strand can end on two or more Pins (usually 2 pins, but a strand\ + \ my be spliced to split a signal). This model supports only 2 ended strands.\r\ + \n A abstract strand may be spliced at both ends and hence\ + \ have no direct relationship to pins or may be connected to pins at one or\ + \ both ends.\r\n In the essential model these Pins would be\ + \ on connectors that plug in to connectors on Equipments.\r\n \ + \ The AbstractStrand is extended to the pins of the AccessPort which are\ + \ the Pins on the Connectors of the Equipment.\r\n In some\ + \ cases it may not be relevant to represent the pin detail and hence the reference\ + \ is to a connector alone." + parameters: + - name: "uuid" + in: "path" + description: "Id of physical-span" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of abstract-strand" + required: true + type: "string" + - name: "connector-identification" + in: "path" + description: "Id of connector-pin" + required: true + type: "string" + - name: "pin-identification" + in: "path" + description: "Id of connector-pin" + required: true + type: "string" + - name: "equipment-uuid" + in: "path" + description: "Id of connector-pin" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.ConnectorPinAddress" + schema: + $ref: "#/definitions/tapi.equipment.ConnectorPinAddress" + 400: + description: "Internal error" + /data/context/physical-context/physical-span={uuid}/abstract-strand={local-id}/name={value-name}/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of physical-span" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of abstract-strand" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/physical-context/physical-span={uuid}/abstract-strand={local-id}/spliced-strand={physical-span-uuid},{abstract-strand-local-id}/ + : get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.AbstractStrandRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of physical-span" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of abstract-strand" + required: true + type: "string" + - name: "physical-span-uuid" + in: "path" + description: "Id of spliced-strand" + required: true + type: "string" + - name: "abstract-strand-local-id" + in: "path" + description: "Id of spliced-strand" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.AbstractStrandRef" + schema: + $ref: "#/definitions/tapi.equipment.AbstractStrandRef" + 400: + description: "Internal error" + /data/context/physical-context/physical-span={uuid}/abstract-strand={local-id}/strand-media-characteristics={value-name}/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.common.NameAndValue" + description: "Relevant physical properties of the abstract strand." + parameters: + - name: "uuid" + in: "path" + description: "Id of physical-span" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of abstract-strand" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of strand-media-characteristics" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/physical-context/physical-span={uuid}/access-port={device-uuid},{access-port-uuid}/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.AccessPortRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of physical-span" + required: true + type: "string" + - name: "device-uuid" + in: "path" + description: "Id of access-port" + required: true + type: "string" + - name: "access-port-uuid" + in: "path" + description: "Id of access-port" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.AccessPortRef" + schema: + $ref: "#/definitions/tapi.equipment.AccessPortRef" + 400: + description: "Internal error" + /data/context/physical-context/physical-span={uuid}/name={value-name}/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of physical-span" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/service-interface-point/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - in: "body" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/service-interface-point={uuid}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePoint" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/available-capacity/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/name/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/service-interface-point={uuid}/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/total-potential-capacity/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] + responses: + 200: + description: "tapi.topology.TopologyContext" + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-topology" + summary: "creates tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: + - in: "body" + name: "tapi.topology.context.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-topology" + summary: "creates or updates tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: + - in: "body" + name: "tapi.topology.context.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-topology" + summary: "removes tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/topology-context/nw-topology-service/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NetworkTopologyService" + description: "none" + parameters: [] + responses: + 200: + description: "tapi.topology.NetworkTopologyService" + schema: + $ref: "#/definitions/tapi.topology.NetworkTopologyService" + 400: + description: "Internal error" + /data/context/topology-context/nw-topology-service/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.TopologyRef" + description: "none" + parameters: + - name: "topology-uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.topologycontext.Topology" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.topologycontext.Topology" + schema: + $ref: "#/definitions/tapi.topology.topologycontext.Topology" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/boundary-node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Link" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Link" + schema: + $ref: "#/definitions/tapi.topology.Link" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.ValidationMechanism" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "validation-mechanism" + in: "path" + description: "Id of validation-mechanism" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.ValidationMechanism" + schema: + $ref: "#/definitions/tapi.topology.ValidationMechanism" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.topology.Node" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.topology.Node" + schema: + $ref: "#/definitions/tapi.topology.topology.Node" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.TopologyRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.node.NodeEdgePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.node.NodeEdgePoint" + schema: + $ref: "#/definitions/tapi.topology.node.NodeEdgePoint" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{aggregated-node-edge-point-node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-cep-layer-protocol={layer-protocol-qualifier}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NepLayerProtocolCapability" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "layer-protocol-qualifier" + in: "path" + description: "Id of available-cep-layer-protocol" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NepLayerProtocolCapability" + schema: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load balancing/Resilience)\ + \ should be considered experimental" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "service-interface-point-uuid" + in: "path" + description: "Id of mapped-service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePointRef" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/supporting-access-port/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.SupportingAccessPort" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.SupportingAccessPort" + schema: + $ref: "#/definitions/tapi.equipment.SupportingAccessPort" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/supporting-access-port/access-port/ + : get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.AccessPortRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.AccessPortRef" + schema: + $ref: "#/definitions/tapi.equipment.AccessPortRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroup" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroup" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-rule-group-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroupRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.InterRuleGroup" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.InterRuleGroup" + schema: + $ref: "#/definitions/tapi.topology.InterRuleGroup" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + - name: "associated-node-rule-group-node-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + - name: "associated-node-rule-group-node-rule-group-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroupRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Rule" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Rule" + schema: + $ref: "#/definitions/tapi.topology.Rule" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-node-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Rule" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Rule" + schema: + $ref: "#/definitions/tapi.topology.Rule" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/supporting-physical-span/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.SupportingPhysicalSpan" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.SupportingPhysicalSpan" + schema: + $ref: "#/definitions/tapi.equipment.SupportingPhysicalSpan" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/supporting-physical-span/physical-span/: + get: + tags: + - "tapi-equipment" + summary: "returns tapi.equipment.PhysicalSpanRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.equipment.PhysicalSpanRef" + schema: + $ref: "#/definitions/tapi.equipment.PhysicalSpanRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /operations/create-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.CreateNotificationSubscriptionService" + description: "operates on tapi.notification.CreateNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.CreateNotificationSubscriptionService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.DeleteNotificationSubscriptionService" + description: "operates on tapi.notification.DeleteNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.deletenotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-device-list/: + post: + tags: + - "tapi-equipment" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.equipment.GetDeviceList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-device/: + post: + tags: + - "tapi-equipment" + summary: "operates on tapi.equipment.GetDevice" + description: "operates on tapi.equipment.GetDevice" + parameters: + - in: "body" + name: "tapi.equipment.getdevice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.equipment.getdevice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.equipment.GetDevice" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-link-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetLinkDetails" + description: "operates on tapi.topology.GetLinkDetails" + parameters: + - in: "body" + name: "tapi.topology.getlinkdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getlinkdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetLinkDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-node-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetNodeDetails" + description: "operates on tapi.topology.GetNodeDetails" + parameters: + - in: "body" + name: "tapi.topology.getnodedetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getnodedetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetNodeDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-node-edge-point-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetNodeEdgePointDetails" + description: "operates on tapi.topology.GetNodeEdgePointDetails" + parameters: + - in: "body" + name: "tapi.topology.getnodeedgepointdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetNodeEdgePointDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-list/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationList" + description: "operates on tapi.notification.GetNotificationList" + parameters: + - in: "body" + name: "tapi.notification.getnotificationlist.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.getnotificationlist.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-subscription-service-details/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + description: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + parameters: + - in: "body" + name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-subscription-service-list/: + post: + tags: + - "tapi-notification" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-physical-span-list/: + post: + tags: + - "tapi-equipment" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.equipment.GetPhysicalSpanList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-physical-span/: + post: + tags: + - "tapi-equipment" + summary: "operates on tapi.equipment.GetPhysicalSpan" + description: "operates on tapi.equipment.GetPhysicalSpan" + parameters: + - in: "body" + name: "tapi.equipment.getphysicalspan.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.equipment.getphysicalspan.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.equipment.GetPhysicalSpan" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-service-interface-point-details/: + post: + tags: + - "tapi-common" + summary: "operates on tapi.common.GetServiceInterfacePointDetails" + description: "operates on tapi.common.GetServiceInterfacePointDetails" + parameters: + - in: "body" + name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.common.GetServiceInterfacePointDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-service-interface-point-list/: + post: + tags: + - "tapi-common" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.common.GetServiceInterfacePointList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-supported-notification-types/: + post: + tags: + - "tapi-notification" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetSupportedNotificationTypes" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-topology-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetTopologyDetails" + description: "operates on tapi.topology.GetTopologyDetails" + parameters: + - in: "body" + name: "tapi.topology.gettopologydetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.gettopologydetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetTopologyDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-topology-list/: + post: + tags: + - "tapi-topology" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetTopologyList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.UpdateNotificationSubscriptionService" + description: "operates on tapi.notification.UpdateNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.UpdateNotificationSubscriptionService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-service-interface-point/: + post: + tags: + - "tapi-common" + summary: "operates on tapi.common.UpdateServiceInterfacePoint" + description: "operates on tapi.common.UpdateServiceInterfacePoint" + parameters: + - in: "body" + name: "tapi.common.updateserviceinterfacepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.common.updateserviceinterfacepoint.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" +definitions: + tapi.common.AdminStatePac: + type: "object" + properties: + operational-state: + description: "none" + $ref: "#/definitions/tapi.common.OperationalState" + lifecycle-state: + description: "none" + $ref: "#/definitions/tapi.common.LifecycleState" + administrative-state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + tapi.common.AdministrativeState: + type: "string" + enum: + - "LOCKED" + - "UNLOCKED" + tapi.common.Capacity: + type: "object" + properties: + total-size: + description: "Total capacity of the TopologicalEntity in MB/s. In case of\ + \ bandwidthProfile, this is expected to same as the committedInformationRate." + $ref: "#/definitions/tapi.common.CapacityValue" + tapi.common.CapacityPac: + type: "object" + properties: + available-capacity: + description: "Capacity available to be assigned." + $ref: "#/definitions/tapi.common.Capacity" + total-potential-capacity: + description: "An optimistic view of the capacity of the TopologicalEntity\ + \ assuming that any shared capacity is available to be taken." + $ref: "#/definitions/tapi.common.Capacity" + tapi.common.CapacityUnit: + type: "string" + enum: + - "TB" + - "TBPS" + - "GB" + - "GBPS" + - "MB" + - "MBPS" + - "KB" + - "KBPS" + - "GHz" + - "MHz" + tapi.common.CapacityValue: + type: "object" + properties: + value: + type: "integer" + format: "int32" + description: "none" + unit: + description: "none" + $ref: "#/definitions/tapi.common.CapacityUnit" + tapi.common.Context: + allOf: + - $ref: "#/definitions/tapi.common.TapiContext" + - $ref: "#/definitions/tapi.equipment.ContextAugmentation2" + - $ref: "#/definitions/tapi.notification.ContextAugmentation1" + - $ref: "#/definitions/tapi.topology.ContextAugmentation3" + tapi.common.ForwardingDirection: + type: "string" + enum: + - "BIDIRECTIONAL" + - "UNIDIRECTIONAL" + - "UNDEFINED_OR_UNKNOWN" + tapi.common.GetServiceInterfacePointDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Output" + tapi.common.GetServiceInterfacePointList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.common.getserviceinterfacepointlist.Output" + tapi.common.GlobalClass: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a UUID\ + \ in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.common.LayerProtocolName: + type: "string" + enum: + - "ODU" + - "ETH" + - "DSR" + - "PHOTONIC_MEDIA" + tapi.common.LifecycleState: + type: "string" + enum: + - "PLANNED" + - "POTENTIAL_AVAILABLE" + - "POTENTIAL_BUSY" + - "INSTALLED" + - "PENDING_REMOVAL" + tapi.common.LocalClass: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + local-id: + type: "string" + description: "none" + tapi.common.NameAndValue: + type: "object" + properties: + value-name: + type: "string" + description: "The name of the value. The value need not have a name." + value: + type: "string" + description: "The value" + tapi.common.OperationalState: + type: "string" + enum: + - "DISABLED" + - "ENABLED" + tapi.common.PortDirection: + type: "string" + enum: + - "BIDIRECTIONAL" + - "INPUT" + - "OUTPUT" + - "UNIDENTIFIED_OR_UNKNOWN" + tapi.common.PortRole: + type: "string" + enum: + - "SYMMETRIC" + - "ROOT" + - "LEAF" + - "TRUNK" + - "UNKNOWN" + tapi.common.ServiceInterfacePoint: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + supported-layer-protocol-qualifier: + type: "array" + description: "none" + items: + type: "string" + layer-protocol-name: + description: "Usage of layerProtocolName [>1] in the ServiceInterfacePoint\ + \ should be considered experimental" + $ref: "#/definitions/tapi.common.LayerProtocolName" + description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ + \ termination and adaptation functions of one or more transport layers. \r\ + \n The structure of LTP supports all transport protocols including\ + \ circuit and packet forms." + tapi.common.ServiceInterfacePointRef: + type: "object" + properties: + service-interface-point-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-common:service-interface-point/tapi-common:uuid" + tapi.common.TapiContext: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + service-interface-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + description: "The Network Control Domain (NCD) object class represents the scope\ + \ of control that a particular SDN controller has with respect to a particular\ + \ network, (i.e., encompassing a designated set of interconnected (virtual)\ + \ network elements)." + tapi.common.TerminationDirection: + type: "string" + enum: + - "BIDIRECTIONAL" + - "SINK" + - "SOURCE" + - "UNDEFINED_OR_UNKNOWN" + tapi.common.TerminationPac: + type: "object" + properties: + termination-direction: + description: "The overall directionality of the LP. \r\n -\ + \ A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ + \ - A SINK LP can only contain elements with SINK flows or CONTRA_DIRECTION_SOURCE\ + \ flows\r\n - A SOURCE LP can only contain SOURCE flows or\ + \ CONTRA_DIRECTION_SINK flows" + $ref: "#/definitions/tapi.common.TerminationDirection" + termination-state: + description: "Indicates whether the layer is terminated and if so how." + $ref: "#/definitions/tapi.common.TerminationState" + tapi.common.TerminationState: + type: "string" + enum: + - "LP_CAN_NEVER_TERMINATE" + - "LT_NOT_TERMINATED" + - "TERMINATED_SERVER_TO_CLIENT_FLOW" + - "TERMINATED_CLIENT_TO_SERVER_FLOW" + - "TERMINATED_BIDIRECTIONAL" + - "LT_PERMENANTLY_TERMINATED" + - "TERMINATION_STATE_UNKNOWN" + tapi.common.TimeRange: + type: "object" + properties: + end-time: + type: "string" + description: "none" + start-time: + type: "string" + description: "none" + tapi.common.getserviceinterfacepointdetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.common.getserviceinterfacepointdetails.Output: + type: "object" + properties: + sip: + description: "none" + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + tapi.common.getserviceinterfacepointlist.Output: + type: "object" + properties: + sip: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + tapi.common.updateserviceinterfacepoint.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + tapi.equipment.AbstractStrand: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + strand-media-characteristics: + type: "array" + description: "Relevant physical properties of the abstract strand." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + connector-pin: + type: "array" + description: "A strand can end on two or more Pins (usually 2 pins, but\ + \ a strand my be spliced to split a signal). This model supports only\ + \ 2 ended strands.\r\n A abstract strand may be spliced\ + \ at both ends and hence have no direct relationship to pins or may be\ + \ connected to pins at one or both ends.\r\n In the essential\ + \ model these Pins would be on connectors that plug in to connectors on\ + \ Equipments.\r\n The AbstractStrand is extended to the\ + \ pins of the AccessPort which are the Pins on the Connectors of the Equipment.\r\ + \n In some cases it may not be relevant to represent the\ + \ pin detail and hence the reference is to a connector alone." + items: + $ref: "#/definitions/tapi.equipment.ConnectorPinAddress" + spliced-strand: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.equipment.AbstractStrandRef" + adjacent-strand: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.equipment.AbstractStrandRef" + description: "This object represents an abstraction of one or more strands in\ + \ series that provides sufficient detail to enable appropriate engineering.\r\ + \n A strand represents a continuous long, thin piece of a medium\ + \ such as glass fiber or copper wire.\r\n In this model a Strand:\r\ + \n - a strand has two ends\r\n - a splice can only be\ + \ between 2 strands.\r\n - the end of a strand may have a splice,\ + \ a connector or be hidden\r\n - only one end can be hidden in\ + \ an equipment\r\n - where a cable has more than two end each strand\ + \ only goes between two of the ends\r\n This model does NOT account\ + \ for multiple copper strands being spliced." + tapi.equipment.AbstractStrandRef: + allOf: + - $ref: "#/definitions/tapi.equipment.PhysicalSpanRef" + - type: "object" + properties: + abstract-strand-local-id: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-equipment:physical-context/tapi-equipment:physical-span/tapi-equipment:abstract-strand/tapi-equipment:local-id" + description: "none" + tapi.equipment.AccessPort: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + connector-pin: + type: "array" + description: "The list of Pins that support the AccessPort." + items: + $ref: "#/definitions/tapi.equipment.ConnectorPinAddress" + description: "A group of pins that together support a signal group where any\ + \ one pin removed from the group will prevent all signals of the signal group\ + \ from flowing successfully.\r\n In some cases the AccessPort may\ + \ simply reference a single connector (e.g., where the pin-connector association\ + \ is simpe such that the AccessPort references all pinsof one connector)." + tapi.equipment.AccessPortRef: + allOf: + - $ref: "#/definitions/tapi.equipment.DeviceRef" + - type: "object" + properties: + access-port-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-equipment:physical-context/tapi-equipment:device/tapi-equipment:access-port/tapi-equipment:uuid" + description: "none" + tapi.equipment.ActualEquipment: + type: "object" + properties: + common-actual-properties: + description: "none" + $ref: "#/definitions/tapi.equipment.CommonActualProperties" + actual-non-field-replaceable-module: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.equipment.ActualNonFieldReplaceableModule" + common-equipment-properties: + description: "none" + $ref: "#/definitions/tapi.equipment.CommonEquipmentProperties" + tapi.equipment.ActualHolder: + type: "object" + properties: + common-holder-properties: + description: "none" + $ref: "#/definitions/tapi.equipment.CommonHolderProperties" + tapi.equipment.ActualNonFieldReplaceableModule: + type: "object" + properties: + common-actual-properties: + description: "none" + $ref: "#/definitions/tapi.equipment.CommonActualProperties" + common-equipment-properties: + description: "none" + $ref: "#/definitions/tapi.equipment.CommonEquipmentProperties" + tapi.equipment.CommonActualProperties: + type: "object" + properties: + temperature: + type: "string" + description: "The measured temperature of the Equipment." + manufacture-date: + type: "string" + description: "This attribute represents the date on which this instance is\ + \ manufactured." + is-powered: + type: "boolean" + description: "The state of the power being supplied to the equipment.\r\n\ + \ Note that this attribute summarizes the power state. \r\ + \n Full details on the actual power system would be provided\ + \ from a number of PC instances representing the relevant parts of the Power\ + \ function (e.g. different voltage supplies)." + default: false + serial-number: + type: "string" + description: "This attribute represents the serial number of this instance." + asset-instance-identifier: + type: "string" + description: "This attribute represents the asset identifier of this instance\ + \ from the manufacturer's perspective." + tapi.equipment.CommonEquipmentProperties: + type: "object" + properties: + equipment-type-version: + type: "string" + description: "This attribute identifies the version of the equipment." + manufacturer-name: + type: "string" + description: "The formal name of the manufacturer of the Equipment." + equipment-type-description: + type: "string" + description: "Text describing the type of Equipment." + manufacturer-identifier: + type: "string" + description: "The formal unique identifier of the manufacturer." + equipment-type-name: + type: "string" + description: "This attribute identifies the type of the equipment." + equipment-type-identifier: + type: "string" + description: "This attribute identifies the part type of the equipment." + asset-type-identifier: + type: "string" + description: "Represents the invariant properties of the equipment asset allocated\ + \ by the operator that define and characterize the type." + tapi.equipment.CommonHolderProperties: + type: "object" + properties: + holder-location: + type: "string" + description: "The relative position of the holder in the context of its containing\ + \ equipment along with the position of that containing Equipment (and further\ + \ recursion)." + is-guided: + type: "boolean" + description: "This attribute indicates whether the holder has guides that\ + \ constrain the position of the equipment in the holder or not." + default: false + holder-category: + type: "string" + description: "The type of holder." + tapi.equipment.ConnectorPinAddress: + type: "object" + properties: + connector-identification: + type: "string" + description: "Identification of the Connector in the conetxt of the referenced\ + \ Equipment." + equipment-uuid: + type: "string" + description: "Reference to the Equipment that is fitted with the Connector/Pin." + pin-identification: + type: "string" + description: "Where relevant, identification of the Pin in the contect of\ + \ the connector.\r\n Where the whole connector is used, then\ + \ individual Pins need not be identified." + tapi.equipment.ContextAugmentation2: + type: "object" + properties: + physical-context: + description: "none" + $ref: "#/definitions/tapi.equipment.PhysicalContext" + x-augmentation: + prefix: "tapi-equipment" + namespace: "urn:onf:otcc:yang:tapi-equipment" + tapi.equipment.Device: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + equipment: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.equipment.Equipment" + access-port: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.equipment.AccessPort" + description: "A logical grouping of Equipments and AccessPorts that are closely\ + \ located and form a support a coherent system of related functions." + tapi.equipment.DeviceRef: + type: "object" + properties: + device-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-equipment:physical-context/tapi-equipment:device/tapi-equipment:uuid" + tapi.equipment.Equipment: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + contained-holder: + type: "array" + description: "References the Holder in an Equipment that is available to\ + \ take other Equipments.\r\n For example:\r\n \ + \ - Slot in a sub-rack\r\n - Slot in a Field Replaceable\ + \ Unit that can take a small form-factor pluggable." + items: + $ref: "#/definitions/tapi.equipment.Holder" + actual-equipment: + description: "none" + $ref: "#/definitions/tapi.equipment.ActualEquipment" + is-expected-actual-mismatch: + type: "boolean" + description: "none" + default: false + geographical-location: + type: "string" + description: "none" + expected-equipment: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.equipment.ExpectedEquipment" + equipment-location: + type: "string" + description: "none" + category: + type: "string" + description: "This attribute provides the identifier for the form of equipments\ + \ regarded as having particular shared characteristics." + description: "Represents any relevant physical thing. \r\n Can be\ + \ either field replaceable or not field replaceable.\r\n Note:\ + \ The model is currently constrained to inside plant." + tapi.equipment.EquipmentRef: + allOf: + - $ref: "#/definitions/tapi.equipment.DeviceRef" + - type: "object" + properties: + equipment-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-equipment:physical-context/tapi-equipment:device/tapi-equipment:equipment/tapi-equipment:uuid" + description: "none" + tapi.equipment.ExpectedEquipment: + type: "object" + properties: + expected-holder: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.equipment.ExpectedHolder" + expected-non-field-replaceable-module: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.equipment.ExpectedNonFieldReplaceableModule" + common-equipment-properties: + description: "none" + $ref: "#/definitions/tapi.equipment.CommonEquipmentProperties" + tapi.equipment.ExpectedHolder: + type: "object" + properties: + common-holder-properties: + description: "none" + $ref: "#/definitions/tapi.equipment.CommonHolderProperties" + tapi.equipment.ExpectedNonFieldReplaceableModule: + type: "object" + properties: + common-equipment-properties: + description: "none" + $ref: "#/definitions/tapi.equipment.CommonEquipmentProperties" + tapi.equipment.GetDevice: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.equipment.getdevice.Output" + tapi.equipment.GetDeviceList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.equipment.getdevicelist.Output" + tapi.equipment.GetPhysicalSpan: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.equipment.getphysicalspan.Output" + tapi.equipment.GetPhysicalSpanList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.equipment.getphysicalspanlist.Output" + tapi.equipment.Holder: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + expected-holder: + description: "none" + $ref: "#/definitions/tapi.equipment.ExpectedHolder" + actual-holder: + description: "none" + $ref: "#/definitions/tapi.equipment.ActualHolder" + occupying-fru: + description: "The FRU that is occupying the holder. \r\n \ + \ A holder may be unoccupied. \r\n An FRU may occupy more\ + \ hat one holder (using or blocking are intentionally not distinguished\ + \ here)." + $ref: "#/definitions/tapi.equipment.EquipmentRef" + description: "Represents a space in an equipment in which another equipment\ + \ can be fitted in the field." + tapi.equipment.NodeAugmentation1: + type: "object" + properties: + supporting-physical-span: + description: "none" + $ref: "#/definitions/tapi.equipment.SupportingPhysicalSpan" + x-augmentation: + prefix: "tapi-equipment" + namespace: "urn:onf:otcc:yang:tapi-equipment" + tapi.equipment.NodeEdgePointAugmentation1: + type: "object" + properties: + supporting-access-port: + description: "none" + $ref: "#/definitions/tapi.equipment.SupportingAccessPort" + x-augmentation: + prefix: "tapi-equipment" + namespace: "urn:onf:otcc:yang:tapi-equipment" + tapi.equipment.PhysicalContext: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + device: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.equipment.Device" + physical-span: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.equipment.PhysicalSpan" + description: "none" + tapi.equipment.PhysicalSpan: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + abstract-strand: + type: "array" + description: "Both the serial segments that form an end-end strand and the\ + \ parallel end-end strands." + items: + $ref: "#/definitions/tapi.equipment.AbstractStrand" + access-port: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.equipment.AccessPortRef" + description: "An adjacency between AccessPorts. \r\n The adjacency\ + \ is supported by a group of strands between pins of the AccessPorts.\r\n\ + \ This is a physical abstraction." + tapi.equipment.PhysicalSpanRef: + type: "object" + properties: + physical-span-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-equipment:physical-context/tapi-equipment:physical-span/tapi-equipment:uuid" + tapi.equipment.SupportingAccessPort: + type: "object" + properties: + access-port: + description: "none" + $ref: "#/definitions/tapi.equipment.AccessPortRef" + tapi.equipment.SupportingPhysicalSpan: + type: "object" + properties: + physical-span: + description: "none" + $ref: "#/definitions/tapi.equipment.PhysicalSpanRef" + tapi.equipment.getdevice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.equipment.getdevice.Output: + type: "object" + properties: + device: + description: "none" + $ref: "#/definitions/tapi.equipment.Device" + tapi.equipment.getdevicelist.Output: + type: "object" + properties: + device: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.equipment.Device" + tapi.equipment.getphysicalspan.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.equipment.getphysicalspan.Output: + type: "object" + properties: + physical-span: + description: "none" + $ref: "#/definitions/tapi.equipment.PhysicalSpan" + tapi.equipment.getphysicalspanlist.Output: + type: "object" + properties: + physical-span: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.equipment.PhysicalSpan" + tapi.notification.ContextAugmentation1: + type: "object" + properties: + notification-context: + description: "Augments the base TAPI Context with NotificationService information" + $ref: "#/definitions/tapi.notification.NotificationContext" + x-augmentation: + prefix: "tapi-notification" + namespace: "urn:onf:otcc:yang:tapi-notification" + tapi.notification.CreateNotificationSubscriptionService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Output" + tapi.notification.GetNotificationList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationlist.Output" + tapi.notification.GetNotificationSubscriptionServiceDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Output" + tapi.notification.GetNotificationSubscriptionServiceList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicelist.Output" + tapi.notification.GetSupportedNotificationTypes: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getsupportednotificationtypes.Output" + tapi.notification.NameAndValueChange: + type: "object" + properties: + value-name: + type: "string" + description: "The name of the value. The value need not have a name." + old-value: + type: "string" + description: "The value" + new-value: + type: "string" + description: "The value" + tapi.notification.Notification: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + target-object-type: + type: "string" + description: "none" + additional-text: + type: "string" + description: "none" + event-time-stamp: + type: "string" + description: "none" + additional-info: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.NameAndValue" + sequence-number: + type: "integer" + format: "int32" + description: "A monotonous increasing sequence number associated with the\ + \ notification.\r\n The exact semantics of how this sequence\ + \ number is assigned (per channel or subscription or source or system)\ + \ is left undefined." + target-object-identifier: + type: "string" + description: "none" + notification-type: + type: "string" + description: "none" + target-object-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.NameAndValue" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + source-indicator: + description: "none" + $ref: "#/definitions/tapi.notification.SourceIndicator" + layer-protocol-qualifier: + type: "string" + description: "none" + changed-attributes: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + description: "none" + tapi.notification.NotificationChannel: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + next-sequence-no: + type: "integer" + format: "int32" + description: "The sequence number of the next notification that will be\ + \ published on the channel" + stream-address: + type: "string" + description: "The address/location/URI of the channel/stream to which the\ + \ subscribed notifications are published.\r\n This specifics\ + \ of this is typically dependent on the implementation protocol & mechanism\ + \ and hence is typed as a string." + description: "none" + tapi.notification.NotificationContext: + type: "object" + properties: + notif-subscription: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.Notification" + tapi.notification.NotificationSubscriptionService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.Notification" + notification-channel: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationChannel" + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + supported-object-types: + type: "array" + description: "none" + items: + type: "string" + supported-notification-types: + type: "array" + description: "none" + items: + type: "string" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + description: "none" + tapi.notification.SourceIndicator: + type: "string" + enum: + - "RESOURCE_OPERATION" + - "MANAGEMENT_OPERATION" + - "UNKNOWN" + tapi.notification.SubscriptionFilter: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + requested-notification-types: + type: "array" + description: "none" + items: + type: "string" + requested-object-identifier: + type: "array" + description: "none" + items: + type: "string" + requested-layer-protocols: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + include-content: + type: "boolean" + description: "Indicates whether the published Notification includes content\ + \ or just the Notification Id (which enables retrieval of the notification\ + \ at the later stage)" + default: false + requested-object-types: + type: "array" + description: "none" + items: + type: "string" + description: "none" + tapi.notification.SubscriptionState: + type: "string" + enum: + - "SUSPENDED" + - "ACTIVE" + tapi.notification.UpdateNotificationSubscriptionService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Output" + tapi.notification.createnotificationsubscriptionservice.Input: + type: "object" + properties: + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + tapi.notification.createnotificationsubscriptionservice.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.deletenotificationsubscriptionservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationlist.Input: + type: "object" + properties: + time-range: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + subscription-id: + type: "string" + description: "UUID of the associated Notification Subscription Service: An\ + \ identifier that is universally unique within an identifier space, where\ + \ the identifier space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationlist.Output: + type: "object" + properties: + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.Notification" + tapi.notification.getnotificationsubscriptionservicedetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationsubscriptionservicedetails.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.getnotificationsubscriptionservicelist.Output: + type: "object" + properties: + subscription-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.getsupportednotificationtypes.Output: + type: "object" + properties: + supported-object-types: + type: "array" + description: "none" + items: + type: "string" + supported-notification-types: + type: "array" + description: "none" + items: + type: "string" + tapi.notification.updatenotificationsubscriptionservice.Input: + type: "object" + properties: + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + tapi.notification.updatenotificationsubscriptionservice.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.topology.ContextAugmentation3: + type: "object" + properties: + topology-context: + description: "Augments the base TAPI Context with TopologyService information" + $ref: "#/definitions/tapi.topology.TopologyContext" + x-augmentation: + prefix: "tapi-topology" + namespace: "urn:onf:otcc:yang:tapi-topology" + tapi.topology.CostCharacteristic: + type: "object" + properties: + cost-value: + type: "string" + description: "The specific cost." + cost-algorithm: + type: "string" + description: "The cost may vary based upon some properties of the TopologicalEntity.\ + \ The rules for the variation are conveyed by the costAlgorithm." + cost-name: + type: "string" + description: "The cost characteristic will related to some aspect of the TopologicalEntity\ + \ (e.g. $ cost, routing weight). This aspect will be conveyed by the costName." + tapi.topology.ForwardingRule: + type: "string" + enum: + - "MAY_FORWARD_ACROSS_GROUP" + - "MUST_FORWARD_ACROSS_GROUP" + - "CANNOT_FORWARD_ACROSS_GROUP" + - "NO_STATEMENT_ON_FORWARDING" + tapi.topology.GetLinkDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getlinkdetails.Output" + tapi.topology.GetNodeDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getnodedetails.Output" + tapi.topology.GetNodeEdgePointDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Output" + tapi.topology.GetTopologyDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.gettopologydetails.Output" + tapi.topology.GetTopologyList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.gettopologylist.Output" + tapi.topology.InterRuleGroup: + allOf: + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + associated-node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + rule: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Rule" + description: "none" + tapi.topology.LatencyCharacteristic: + type: "object" + properties: + traffic-property-name: + type: "string" + description: "The identifier of the specific traffic property to which the\ + \ queuing latency applies." + jitter-characteristic: + type: "string" + description: "High frequency deviation from true periodicity of a signal and\ + \ therefore a small high rate of change of transfer latency.\r\n \ + \ Applies to TDM systems (and not packet)." + fixed-latency-characteristic: + type: "string" + description: "A TopologicalEntity suffers delay caused by the realization\ + \ of the servers (e.g. distance related; FEC encoding etc.) along with some\ + \ client specific processing. This is the total average latency effect of\ + \ the TopologicalEntity" + wander-characteristic: + type: "string" + description: "Low frequency deviation from true periodicity of a signal and\ + \ therefore a small low rate of change of transfer latency.\r\n \ + \ Applies to TDM systems (and not packet)." + queing-latency-characteristic: + type: "string" + description: "The specific queuing latency for the traffic property." + tapi.topology.LayerProtocolTransitionPac: + type: "object" + properties: + transitioned-layer-protocol-name: + type: "array" + description: "Provides the ordered structure of layer protocol transitions\ + \ encapsulated in the TopologicalEntity. The ordering relates to the LinkPort\ + \ role." + items: + type: "string" + tapi.topology.Link: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.LayerProtocolTransitionPac" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - $ref: "#/definitions/tapi.topology.ValidationPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + restoration-policy: + description: "none" + $ref: "#/definitions/tapi.topology.RestorationPolicy" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" + direction: + description: "The directionality of the Link. \r\n Is applicable\ + \ to simple Links where all LinkEnds are BIDIRECTIONAL (the Link will\ + \ be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ + \ \r\n Is not present in more complex cases." + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "The Link object class models effective adjacency between two or\ + \ more ForwardingDomains (FD). " + tapi.topology.NepLayerProtocolCapability: + type: "object" + properties: + layer-protocol-qualifier: + type: "string" + description: "none" + number-of-cep-instances: + type: "integer" + format: "int32" + description: "none" + tapi.topology.NetworkTopologyService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.TopologyRef" + description: "none" + tapi.topology.Node: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + encap-topology: + description: "none" + $ref: "#/definitions/tapi.topology.TopologyRef" + node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePoint" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ + \ topological component which is used to effect forwarding of transport characteristic\ + \ information and offers the potential to enable forwarding. \r\n \ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ multiple switch matrices (FDs). " + tapi.topology.NodeEdgePoint: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.common.TerminationPac" + - type: "object" + properties: + link-port-role: + description: "Each LinkEnd of the Link has a role (e.g., symmetric, hub,\ + \ spoke, leaf, root) in the context of the Link with respect to the Link\ + \ function. " + $ref: "#/definitions/tapi.common.PortRole" + mapped-service-interface-point: + type: "array" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load\ + \ balancing/Resilience) should be considered experimental" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + available-cep-layer-protocol: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + link-port-direction: + description: "The orientation of defined flow at the LinkEnd." + $ref: "#/definitions/tapi.common.PortDirection" + description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ + \ termination and adaptation functions of one or more transport layers. \r\ + \n The structure of LTP supports all transport protocols including\ + \ circuit and packet forms." + tapi.topology.NodeEdgePointRef: + allOf: + - $ref: "#/definitions/tapi.topology.NodeRef" + - type: "object" + properties: + node-edge-point-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-edge-point/tapi-topology:uuid" + description: "none" + tapi.topology.NodeRef: + allOf: + - $ref: "#/definitions/tapi.topology.TopologyRef" + - type: "object" + properties: + node-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:uuid" + description: "none" + tapi.topology.NodeRuleGroup: + allOf: + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + inter-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.InterRuleGroup" + rule: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Rule" + composed-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "none" + tapi.topology.NodeRuleGroupRef: + allOf: + - $ref: "#/definitions/tapi.topology.NodeRef" + - type: "object" + properties: + node-rule-group-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-rule-group/tapi-topology:uuid" + description: "none" + tapi.topology.ProtectionType: + type: "string" + enum: + - "NO_PROTECTION" + - "ONE_PLUS_ONE_PROTECTION" + - "ONE_FOR_ONE_PROTECTION" + - "ONE_FOR_N_PROTECTION" + - "M_FOR_N_PROTECTION" + - "ONE_FOR_ONE_BY_N" + tapi.topology.RestorationPolicy: + type: "string" + enum: + - "PER_DOMAIN_RESTORATION" + - "END_TO_END_RESTORATION" + - "NA" + - "DYNAMIC_RESTORATION" + - "PRE_COMPUTED_RESTORATION" + tapi.topology.RiskCharacteristic: + type: "object" + properties: + risk-characteristic-name: + type: "string" + description: "The name of the risk characteristic. The characteristic may\ + \ be related to a specific degree of closeness. \r\n For\ + \ example a particular characteristic may apply to failures that are localized\ + \ (e.g. to one side of a road) where as another characteristic may relate\ + \ to failures that have a broader impact (e.g. both sides of a road that\ + \ crosses a bridge).\r\n Depending upon the importance of\ + \ the traffic being routed different risk characteristics will be evaluated." + risk-identifier-list: + type: "array" + description: "A list of the identifiers of each physical/geographic unit (with\ + \ the specific risk characteristic) that is related to a segment of the\ + \ TopologicalEntity." + items: + type: "string" + tapi.topology.RiskParameterPac: + type: "object" + properties: + risk-characteristic: + type: "array" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + items: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + tapi.topology.Rule: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + override-priority: + type: "integer" + format: "int32" + description: "none" + forwarding-rule: + description: "none" + $ref: "#/definitions/tapi.topology.ForwardingRule" + rule-type: + description: "none" + $ref: "#/definitions/tapi.topology.RuleType" + description: "none" + tapi.topology.RuleType: + type: "string" + enum: + - "FORWARDING" + - "CAPACITY" + - "COST" + - "TIMING" + - "RISK" + - "GROUPING" + tapi.topology.Topology: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + link: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Link" + node: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Node" + boundary-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ + \ topological component which is used to effect forwarding of transport characteristic\ + \ information and offers the potential to enable forwarding. \r\n \ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ multiple switch matrices (FDs). " + tapi.topology.TopologyContext: + type: "object" + properties: + nw-topology-service: + description: "none" + $ref: "#/definitions/tapi.topology.NetworkTopologyService" + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.TopologyRef: + type: "object" + properties: + topology-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:uuid" + tapi.topology.TransferCostPac: + type: "object" + properties: + cost-characteristic: + type: "array" + description: "The list of costs where each cost relates to some aspect of\ + \ the TopologicalEntity." + items: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + tapi.topology.TransferIntegrityPac: + type: "object" + properties: + error-characteristic: + type: "string" + description: "Describes the degree to which the signal propagated can be errored.\ + \ \r\n Applies to TDM systems as the errored signal will\ + \ be propagated and not packet as errored packets will be discarded." + unavailable-time-characteristic: + type: "string" + description: "Describes the duration for which there may be no valid signal\ + \ propagated." + server-integrity-process-characteristic: + type: "string" + description: "Describes the effect of any server integrity enhancement process\ + \ on the characteristics of the TopologicalEntity." + delivery-order-characteristic: + type: "string" + description: "Describes the degree to which packets will be delivered out\ + \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ + \ maintain strict order." + repeat-delivery-characteristic: + type: "string" + description: "Primarily applies to packet systems where a packet may be delivered\ + \ more than once (in fault recovery for example). \r\n It\ + \ can also apply to TDM where several frames may be received twice due to\ + \ switching in a system with a large differential propagation delay." + loss-characteristic: + type: "string" + description: "Describes the acceptable characteristic of lost packets where\ + \ loss may result from discard due to errors or overflow.\r\n \ + \ Applies to packet systems and not TDM (as for TDM errored signals\ + \ are propagated unless grossly errored and overflow/underflow turns into\ + \ timing slips)." + tapi.topology.TransferTimingPac: + type: "object" + properties: + latency-characteristic: + type: "array" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + items: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + tapi.topology.ValidationMechanism: + type: "object" + properties: + layer-protocol-adjacency-validated: + type: "string" + description: "State of validatiion" + validation-mechanism: + type: "string" + description: "Name of mechanism used to validate adjacency" + validation-robustness: + type: "string" + description: "Quality of validation (i.e. how likely is the stated validation\ + \ to be invalid)" + tapi.topology.ValidationPac: + type: "object" + properties: + validation-mechanism: + type: "array" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." + items: + $ref: "#/definitions/tapi.topology.ValidationMechanism" + tapi.topology.getlinkdetails.Input: + type: "object" + properties: + link-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getlinkdetails.Output: + type: "object" + properties: + link: + description: "none" + $ref: "#/definitions/tapi.topology.Link" + tapi.topology.getnodedetails.Input: + type: "object" + properties: + node-id: + type: "string" + description: "UUID of the Node: An identifier that is universally unique within\ + \ an identifier space, where the identifier space is itself globally unique,\ + \ and immutable.\r\n An UUID carries no semantics with\ + \ respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The canonical\ + \ representation uses lowercase characters.\r\n Pattern:\ + \ [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getnodedetails.Output: + type: "object" + properties: + node: + description: "none" + $ref: "#/definitions/tapi.topology.Node" + tapi.topology.getnodeedgepointdetails.Input: + type: "object" + properties: + node-id: + type: "string" + description: "UUID of the parent Node: An identifier that is universally unique\ + \ within an identifier space, where the identifier space is itself globally\ + \ unique, and immutable.\r\n An UUID carries no semantics\ + \ with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The\ + \ canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Node's Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + node-edge-point-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getnodeedgepointdetails.Output: + type: "object" + properties: + node-edge-point: + description: "none" + $ref: "#/definitions/tapi.topology.NodeEdgePoint" + tapi.topology.gettopologydetails.Input: + type: "object" + properties: + topology-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.gettopologydetails.Output: + type: "object" + properties: + topology: + description: "none" + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.gettopologylist.Output: + type: "object" + properties: + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.node.NodeEdgePoint: + allOf: + - $ref: "#/definitions/tapi.equipment.NodeEdgePointAugmentation1" + - $ref: "#/definitions/tapi.topology.NodeEdgePoint" + tapi.topology.topology.Node: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.equipment.NodeAugmentation1" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + encap-topology: + description: "none" + $ref: "#/definitions/tapi.topology.TopologyRef" + node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.node.NodeEdgePoint" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "none" + tapi.topology.topologycontext.Topology: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + link: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Link" + node: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.topology.Node" + boundary-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "none" diff --git a/OAS/tapi-eth@2019-03-31.yaml b/OAS/tapi-eth@2019-03-31.yaml new file mode 100644 index 00000000..779fe2db --- /dev/null +++ b/OAS/tapi-eth@2019-03-31.yaml @@ -0,0 +1,25640 @@ +--- +swagger: "2.0" +info: + description: "\r\n This module contains TAPI Notification Model definitions.\r\ + \n Source: TapiNotification.uml\r\n Copyright (c) 2018 Open Networking\ + \ Foundation (ONF). All rights reserved.\r\n License: This module is distributed\ + \ under the Apache License 2.0\r\n - The TAPI YANG models included in this\ + \ TAPI release are a *normative* part of the TAPI SDK.\r\n - The YANG specifications\ + \ have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG\ + \ mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Topology\ + \ Model definitions.\r\n Source: TapiTopology.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI ETH Model\ + \ definitions.\r\n Source: TapiEth.uml\r\n Copyright (c) 2018 Open\ + \ Networking Foundation (ONF). All rights reserved.\r\n License: This module\ + \ is distributed under the Apache License 2.0\r\n - The TAPI YANG models\ + \ included in this TAPI release are a *normative* part of the TAPI SDK.\r\n \ + \ - The YANG specifications have been generated from the corresponding UML\ + \ model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI DSR Model\ + \ definitions.\r\n Source: TapiDsr.uml\r\n Copyright (c) 2018 Open\ + \ Networking Foundation (ONF). All rights reserved.\r\n License: This module\ + \ is distributed under the Apache License 2.0\r\n - The TAPI YANG models\ + \ included in this TAPI release are a *normative* part of the TAPI SDK.\r\n \ + \ - The YANG specifications have been generated from the corresponding UML\ + \ model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Common Model\ + \ definitions.\r\n Source: TapiCommon.uml\r\n Copyright (c) 2018\ + \ Open Networking Foundation (ONF). All rights reserved.\r\n License: This\ + \ module is distributed under the Apache License 2.0\r\n - The TAPI YANG\ + \ models included in this TAPI release are a *normative* part of the TAPI SDK.\r\ + \n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Path Computation\ + \ Model definitions.\r\n Source: TapiPathComputation.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Connectivity\ + \ Model definitions.\r\n Source: TapiConnectivity.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI OAM Model\ + \ definitions.\r\n Source: TapiOam.uml\r\n Copyright (c) 2018 Open\ + \ Networking Foundation (ONF). All rights reserved.\r\n License: This module\ + \ is distributed under the Apache License 2.0\r\n - The TAPI YANG models\ + \ included in this TAPI release are a *normative* part of the TAPI SDK.\r\n \ + \ - The YANG specifications have been generated from the corresponding UML\ + \ model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases." + version: "2.2.0" + title: "tapi-notification,tapi-topology,tapi-eth,tapi-dsr,tapi-common,tapi-path-computation,tapi-connectivity,tapi-oam\ + \ API" +host: "localhost:1234" +consumes: +- "application/yang-data+json" +produces: +- "application/yang-data+json" +paths: + /data/context/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Context" + description: "none" + parameters: [] + responses: + 200: + description: "tapi.common.Context" + schema: + $ref: "#/definitions/tapi.common.Context" + 400: + description: "Internal error" + post: + tags: + - "tapi-common" + summary: "creates tapi.common.Context" + description: "none" + parameters: + - in: "body" + name: "tapi.common.Context.body-param" + description: "tapi.common.Context to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.Context" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.Context" + description: "none" + parameters: + - in: "body" + name: "tapi.common.Context.body-param" + description: "tapi.common.Context to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.Context" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.Context" + description: "none" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.context.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" + parameters: [] + responses: + 200: + description: "tapi.connectivity.context.ConnectivityContext" + schema: + $ref: "#/definitions/tapi.connectivity.context.ConnectivityContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.connectivity.context.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" + parameters: + - in: "body" + name: "tapi.connectivity.context.ConnectivityContext.body-param" + description: "tapi.connectivity.context.ConnectivityContext to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.context.ConnectivityContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.connectivity.context.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" + parameters: + - in: "body" + name: "tapi.connectivity.context.ConnectivityContext.body-param" + description: "tapi.connectivity.context.ConnectivityContext to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.context.ConnectivityContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.connectivity.context.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/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.Connection" + 400: + description: "Internal error" + /data/context/connectivity-context/connection={uuid}/bounding-node/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.topology.NodeRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connection" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRef" + 400: + description: "Internal error" + ? /data/context/connectivity-context/connection={uuid}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ + : get: + tags: + - "tapi-connectivity" + 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.ConnectionEndPointRef" + 400: + description: "Internal error" + /data/context/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.ConnectionRef" + 400: + description: "Internal error" + /data/context/connectivity-context/connection={uuid}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of 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.NameAndValue" + 400: + description: "Internal error" + /data/context/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.Route" + 400: + description: "Internal error" + ? /data/context/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.ConnectionEndPointRef" + 400: + description: "Internal error" + /data/context/connectivity-context/connection={uuid}/route={local-id}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of 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.NameAndValue" + 400: + description: "Internal error" + /data/context/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.LinkRef" + 400: + description: "Internal error" + /data/context/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.SwitchControl" + 400: + description: "Internal error" + /data/context/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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n 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.NameAndValue" + 400: + description: "Internal error" + ? /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/sub-switch-control={connection-uuid},{sub-switch-control-switch-control-uuid}/ + : get: + tags: + - "tapi-connectivity" + 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.SwitchControlRef" + 400: + description: "Internal error" + /data/context/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.Switch" + 400: + description: "Internal error" + /data/context/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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n 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.NameAndValue" + 400: + description: "Internal error" + ? /data/context/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.ConnectionEndPointRef" + 400: + description: "Internal error" + ? /data/context/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.RouteRef" + 400: + description: "Internal error" + /data/context/connectivity-context/connectivity-service/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.connectivity.connectivitycontext.ConnectivityService" + description: "none" + parameters: + - in: "body" + name: "tapi.connectivity.connectivitycontext.ConnectivityService.body-param" + description: "tapi.connectivity.connectivitycontext.ConnectivityService to\ + \ be added to list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.connectivitycontext.ConnectivityService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.connectivitycontext.ConnectivityService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.connectivitycontext.ConnectivityService" + schema: + $ref: "#/definitions/tapi.connectivity.connectivitycontext.ConnectivityService" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.connectivity.connectivitycontext.ConnectivityService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.connectivitycontext.ConnectivityService.body-param" + description: "tapi.connectivity.connectivitycontext.ConnectivityService to\ + \ be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.connectivitycontext.ConnectivityService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.connectivity.connectivitycontext.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/context/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.ConnectionRef" + 400: + description: "Internal error" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.ConnectivityConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.ConnectivityConstraint" + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.connectivity.ConnectivityConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ConnectivityConstraint.body-param" + description: "tapi.connectivity.ConnectivityConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.connectivity.ConnectivityConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ConnectivityConstraint.body-param" + description: "tapi.connectivity.ConnectivityConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.connectivity.ConnectivityConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.ConnectivityServiceRef" + 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.ConnectivityServiceRef" + 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.ConnectivityServiceRef" + 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/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.ConnectivityServiceRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.ConnectivityServiceRef" + 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.ConnectivityServiceRef" + 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/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.Capacity" + 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.Capacity" + 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.Capacity" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.CapacityValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-connectivity" + 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.CapacityValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.TimeRange" + 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.TimeRange" + 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.TimeRange" + 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/context/connectivity-context/connectivity-service={uuid}/end-point/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.connectivity.connectivityservice.EndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.connectivityservice.EndPoint.body-param" + description: "tapi.connectivity.connectivityservice.EndPoint to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.connectivityservice.EndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.connectivityservice.EndPoint" + schema: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.connectivity.connectivityservice.EndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.connectivityservice.EndPoint.body-param" + description: "tapi.connectivity.connectivityservice.EndPoint to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.connectivity.connectivityservice.EndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/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.Capacity" + 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.Capacity" + 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.Capacity" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/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.CapacityValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-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.CapacityValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/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.ConnectionEndPointRef" + 400: + description: "Internal error" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthConnectivityServiceEndPointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + 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.eth.EthConnectivityServiceEndPointSpec" + schema: + $ref: "#/definitions/tapi.eth.EthConnectivityServiceEndPointSpec" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthConnectivityServiceEndPointSpec" + 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.eth.EthConnectivityServiceEndPointSpec.body-param" + description: "tapi.eth.EthConnectivityServiceEndPointSpec to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthConnectivityServiceEndPointSpec" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthConnectivityServiceEndPointSpec" + 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.eth.EthConnectivityServiceEndPointSpec.body-param" + description: "tapi.eth.EthConnectivityServiceEndPointSpec to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthConnectivityServiceEndPointSpec" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthConnectivityServiceEndPointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/eth-ctp-common-pac/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthCtpCommonPac" + 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.eth.EthCtpCommonPac" + schema: + $ref: "#/definitions/tapi.eth.EthCtpCommonPac" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthCtpCommonPac" + 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.eth.EthCtpCommonPac.body-param" + description: "tapi.eth.EthCtpCommonPac to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthCtpCommonPac" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthCtpCommonPac" + 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.eth.EthCtpCommonPac.body-param" + description: "tapi.eth.EthCtpCommonPac to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthCtpCommonPac" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthCtpCommonPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/eth-ctp-common-pac/filter-config/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.ControlFrameFilter" + description: "This attribute models the FilterConfig MI defined in section 8.3/G.8021.\ + \ It indicates the configured filter action for each of the 33 group MAC addresses\ + \ for control frames. The 33 MAC addresses are:\r\n - All bridges\ + \ address: 01-80-C2-00-00-10,\r\n - Reserved addresses: 01-80-C2-00-00-00\ + \ to 01-80-C2-00-00-0F,\r\n - GARP Application addresses: 01-80-C2-00-00-20\ + \ to 01-80-C2-00-00-2F.\r\n The filter action is Pass or Block.\ + \ \r\n If the destination address of the incoming ETH_CI_D\ + \ matches one of the above addresses, the filter process shall perform the\ + \ corresponding configured filter action. \r\n If none of the\ + \ above addresses match, the ETH_CI_D is passed." + parameters: + - name: "uuid" + in: "path" + 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.eth.ControlFrameFilter" + schema: + $ref: "#/definitions/tapi.eth.ControlFrameFilter" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.ControlFrameFilter" + description: "This attribute models the FilterConfig MI defined in section 8.3/G.8021.\ + \ It indicates the configured filter action for each of the 33 group MAC addresses\ + \ for control frames. The 33 MAC addresses are:\r\n - All bridges\ + \ address: 01-80-C2-00-00-10,\r\n - Reserved addresses: 01-80-C2-00-00-00\ + \ to 01-80-C2-00-00-0F,\r\n - GARP Application addresses: 01-80-C2-00-00-20\ + \ to 01-80-C2-00-00-2F.\r\n The filter action is Pass or Block.\ + \ \r\n If the destination address of the incoming ETH_CI_D\ + \ matches one of the above addresses, the filter process shall perform the\ + \ corresponding configured filter action. \r\n If none of the\ + \ above addresses match, the ETH_CI_D is passed." + parameters: + - name: "uuid" + in: "path" + 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.eth.ControlFrameFilter.body-param" + description: "tapi.eth.ControlFrameFilter to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.ControlFrameFilter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.ControlFrameFilter" + description: "This attribute models the FilterConfig MI defined in section 8.3/G.8021.\ + \ It indicates the configured filter action for each of the 33 group MAC addresses\ + \ for control frames. The 33 MAC addresses are:\r\n - All bridges\ + \ address: 01-80-C2-00-00-10,\r\n - Reserved addresses: 01-80-C2-00-00-00\ + \ to 01-80-C2-00-00-0F,\r\n - GARP Application addresses: 01-80-C2-00-00-20\ + \ to 01-80-C2-00-00-2F.\r\n The filter action is Pass or Block.\ + \ \r\n If the destination address of the incoming ETH_CI_D\ + \ matches one of the above addresses, the filter process shall perform the\ + \ corresponding configured filter action. \r\n If none of the\ + \ above addresses match, the ETH_CI_D is passed." + parameters: + - name: "uuid" + in: "path" + 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.eth.ControlFrameFilter.body-param" + description: "tapi.eth.ControlFrameFilter to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.ControlFrameFilter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.ControlFrameFilter" + description: "This attribute models the FilterConfig MI defined in section 8.3/G.8021.\ + \ It indicates the configured filter action for each of the 33 group MAC addresses\ + \ for control frames. The 33 MAC addresses are:\r\n - All bridges\ + \ address: 01-80-C2-00-00-10,\r\n - Reserved addresses: 01-80-C2-00-00-00\ + \ to 01-80-C2-00-00-0F,\r\n - GARP Application addresses: 01-80-C2-00-00-20\ + \ to 01-80-C2-00-00-2F.\r\n The filter action is Pass or Block.\ + \ \r\n If the destination address of the incoming ETH_CI_D\ + \ matches one of the above addresses, the filter process shall perform the\ + \ corresponding configured filter action. \r\n If none of the\ + \ above addresses match, the ETH_CI_D is passed." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/eth-ctp-common-pac/traffic-conditioning-pac/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.TrafficConditioningPac" + 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.eth.TrafficConditioningPac" + schema: + $ref: "#/definitions/tapi.eth.TrafficConditioningPac" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.TrafficConditioningPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.eth.TrafficConditioningPac.body-param" + description: "tapi.eth.TrafficConditioningPac to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.TrafficConditioningPac" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.TrafficConditioningPac" + 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.eth.TrafficConditioningPac.body-param" + description: "tapi.eth.TrafficConditioningPac to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.TrafficConditioningPac" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.TrafficConditioningPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/eth-ctp-common-pac/traffic-conditioning-pac/cond-config-list/ + : post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.TrafficConditioningConfiguration" + description: "This attribute indicates for the conditioner process the conditioning\ + \ parameters:\r\n - Queue ID: Indicates the Queue ID\r\n \ + \ - Committed Information Rate (CIR): number of bits per second\r\ + \n - Committed Burst Size (CBS): number of bytes\r\n \ + \ - Excess Information Rate (EIR): number of bits per second\r\n\ + \ - Excess Burst Size (EBS): number of bytes\r\n \ + \ - Coupling flag (CF): 0 or 1\r\n - Color mode (CM):\ + \ color-blind and color-aware." + parameters: + - name: "uuid" + in: "path" + 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.eth.TrafficConditioningConfiguration.body-param" + description: "tapi.eth.TrafficConditioningConfiguration to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.TrafficConditioningConfiguration" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/eth-ctp-common-pac/traffic-conditioning-pac/cond-config-list={queue-id}/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.TrafficConditioningConfiguration" + description: "This attribute indicates for the conditioner process the conditioning\ + \ parameters:\r\n - Queue ID: Indicates the Queue ID\r\n \ + \ - Committed Information Rate (CIR): number of bits per second\r\ + \n - Committed Burst Size (CBS): number of bytes\r\n \ + \ - Excess Information Rate (EIR): number of bits per second\r\n\ + \ - Excess Burst Size (EBS): number of bytes\r\n \ + \ - Coupling flag (CF): 0 or 1\r\n - Color mode (CM):\ + \ color-blind and color-aware." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "queue-id" + in: "path" + description: "Id of cond-config-list" + required: true + type: "integer" + format: "int32" + responses: + 200: + description: "tapi.eth.TrafficConditioningConfiguration" + schema: + $ref: "#/definitions/tapi.eth.TrafficConditioningConfiguration" + 400: + description: "Internal error" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.TrafficConditioningConfiguration" + description: "This attribute indicates for the conditioner process the conditioning\ + \ parameters:\r\n - Queue ID: Indicates the Queue ID\r\n \ + \ - Committed Information Rate (CIR): number of bits per second\r\ + \n - Committed Burst Size (CBS): number of bytes\r\n \ + \ - Excess Information Rate (EIR): number of bits per second\r\n\ + \ - Excess Burst Size (EBS): number of bytes\r\n \ + \ - Coupling flag (CF): 0 or 1\r\n - Color mode (CM):\ + \ color-blind and color-aware." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "queue-id" + in: "path" + description: "Id of cond-config-list" + required: true + type: "integer" + format: "int32" + - in: "body" + name: "tapi.eth.TrafficConditioningConfiguration.body-param" + description: "tapi.eth.TrafficConditioningConfiguration to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.TrafficConditioningConfiguration" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.TrafficConditioningConfiguration" + description: "This attribute indicates for the conditioner process the conditioning\ + \ parameters:\r\n - Queue ID: Indicates the Queue ID\r\n \ + \ - Committed Information Rate (CIR): number of bits per second\r\ + \n - Committed Burst Size (CBS): number of bytes\r\n \ + \ - Excess Information Rate (EIR): number of bits per second\r\n\ + \ - Excess Burst Size (EBS): number of bytes\r\n \ + \ - Coupling flag (CF): 0 or 1\r\n - Color mode (CM):\ + \ color-blind and color-aware." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "queue-id" + in: "path" + description: "Id of cond-config-list" + required: true + type: "integer" + format: "int32" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/eth-ctp-common-pac/traffic-conditioning-pac/prio-config-list/ + : post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.PriorityConfiguration" + description: "This attribute indicates the Priority Splitter function for the\ + \ mapping of the Ethernet frame priority (ETH_CI_P) values to the output queue." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.eth.PriorityConfiguration.body-param" + description: "tapi.eth.PriorityConfiguration to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.PriorityConfiguration" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/eth-ctp-common-pac/traffic-conditioning-pac/prio-config-list={queue-id}/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.PriorityConfiguration" + description: "This attribute indicates the Priority Splitter function for the\ + \ mapping of the Ethernet frame priority (ETH_CI_P) values to the output queue." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "queue-id" + in: "path" + description: "Id of prio-config-list" + required: true + type: "integer" + format: "int32" + responses: + 200: + description: "tapi.eth.PriorityConfiguration" + schema: + $ref: "#/definitions/tapi.eth.PriorityConfiguration" + 400: + description: "Internal error" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.PriorityConfiguration" + description: "This attribute indicates the Priority Splitter function for the\ + \ mapping of the Ethernet frame priority (ETH_CI_P) values to the output queue." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "queue-id" + in: "path" + description: "Id of prio-config-list" + required: true + type: "integer" + format: "int32" + - in: "body" + name: "tapi.eth.PriorityConfiguration.body-param" + description: "tapi.eth.PriorityConfiguration to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.PriorityConfiguration" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.PriorityConfiguration" + description: "This attribute indicates the Priority Splitter function for the\ + \ mapping of the Ethernet frame priority (ETH_CI_P) values to the output queue." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "queue-id" + in: "path" + description: "Id of prio-config-list" + required: true + type: "integer" + format: "int32" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/eth-ctp-common-pac/traffic-shaping-pac/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.TrafficShapingPac" + 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.eth.TrafficShapingPac" + schema: + $ref: "#/definitions/tapi.eth.TrafficShapingPac" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.TrafficShapingPac" + 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.eth.TrafficShapingPac.body-param" + description: "tapi.eth.TrafficShapingPac to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.TrafficShapingPac" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.TrafficShapingPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.eth.TrafficShapingPac.body-param" + description: "tapi.eth.TrafficShapingPac to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.TrafficShapingPac" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.TrafficShapingPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/eth-ctp-common-pac/traffic-shaping-pac/prio-config-list/ + : post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.PriorityConfiguration" + description: "This attribute configures the Priority Splitter function for the\ + \ mapping of the Ethernet frame priority (ETH_CI_P) values to the output queue." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.eth.PriorityConfiguration.body-param" + description: "tapi.eth.PriorityConfiguration to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.PriorityConfiguration" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/eth-ctp-common-pac/traffic-shaping-pac/prio-config-list={queue-id}/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.PriorityConfiguration" + description: "This attribute configures the Priority Splitter function for the\ + \ mapping of the Ethernet frame priority (ETH_CI_P) values to the output queue." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "queue-id" + in: "path" + description: "Id of prio-config-list" + required: true + type: "integer" + format: "int32" + responses: + 200: + description: "tapi.eth.PriorityConfiguration" + schema: + $ref: "#/definitions/tapi.eth.PriorityConfiguration" + 400: + description: "Internal error" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.PriorityConfiguration" + description: "This attribute configures the Priority Splitter function for the\ + \ mapping of the Ethernet frame priority (ETH_CI_P) values to the output queue." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "queue-id" + in: "path" + description: "Id of prio-config-list" + required: true + type: "integer" + format: "int32" + - in: "body" + name: "tapi.eth.PriorityConfiguration.body-param" + description: "tapi.eth.PriorityConfiguration to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.PriorityConfiguration" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.PriorityConfiguration" + description: "This attribute configures the Priority Splitter function for the\ + \ mapping of the Ethernet frame priority (ETH_CI_P) values to the output queue." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "queue-id" + in: "path" + description: "Id of prio-config-list" + required: true + type: "integer" + format: "int32" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/eth-ctp-common-pac/traffic-shaping-pac/queue-config-list/ + : post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.QueueConfiguration" + description: "This attribute configures the Queue depth and Dropping threshold\ + \ parameters of the Queue process. The Queue depth sets the maximum size of\ + \ the queue in bytes. An incoming ETH_CI traffic unit is dropped if there\ + \ is insufficient space in the queue to hold the whole unit. The Dropping\ + \ threshold sets the threshold of the queue. If the queue is filled beyond\ + \ this threshold, incoming ETH_CI traffic units accompanied by the ETH_CI_DE\ + \ signal set are dropped." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.eth.QueueConfiguration.body-param" + description: "tapi.eth.QueueConfiguration to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.QueueConfiguration" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/eth-ctp-common-pac/traffic-shaping-pac/queue-config-list={queue-id}/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.QueueConfiguration" + description: "This attribute configures the Queue depth and Dropping threshold\ + \ parameters of the Queue process. The Queue depth sets the maximum size of\ + \ the queue in bytes. An incoming ETH_CI traffic unit is dropped if there\ + \ is insufficient space in the queue to hold the whole unit. The Dropping\ + \ threshold sets the threshold of the queue. If the queue is filled beyond\ + \ this threshold, incoming ETH_CI traffic units accompanied by the ETH_CI_DE\ + \ signal set are dropped." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "queue-id" + in: "path" + description: "Id of queue-config-list" + required: true + type: "integer" + format: "int32" + responses: + 200: + description: "tapi.eth.QueueConfiguration" + schema: + $ref: "#/definitions/tapi.eth.QueueConfiguration" + 400: + description: "Internal error" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.QueueConfiguration" + description: "This attribute configures the Queue depth and Dropping threshold\ + \ parameters of the Queue process. The Queue depth sets the maximum size of\ + \ the queue in bytes. An incoming ETH_CI traffic unit is dropped if there\ + \ is insufficient space in the queue to hold the whole unit. The Dropping\ + \ threshold sets the threshold of the queue. If the queue is filled beyond\ + \ this threshold, incoming ETH_CI traffic units accompanied by the ETH_CI_DE\ + \ signal set are dropped." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "queue-id" + in: "path" + description: "Id of queue-config-list" + required: true + type: "integer" + format: "int32" + - in: "body" + name: "tapi.eth.QueueConfiguration.body-param" + description: "tapi.eth.QueueConfiguration to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.QueueConfiguration" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.QueueConfiguration" + description: "This attribute configures the Queue depth and Dropping threshold\ + \ parameters of the Queue process. The Queue depth sets the maximum size of\ + \ the queue in bytes. An incoming ETH_CI traffic unit is dropped if there\ + \ is insufficient space in the queue to hold the whole unit. The Dropping\ + \ threshold sets the threshold of the queue. If the queue is filled beyond\ + \ this threshold, incoming ETH_CI traffic units accompanied by the ETH_CI_DE\ + \ signal set are dropped." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "queue-id" + in: "path" + description: "Id of queue-config-list" + required: true + type: "integer" + format: "int32" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/eth-termination-common-pac/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthTerminationCommonPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthTerminationCommonPac" + schema: + $ref: "#/definitions/tapi.eth.EthTerminationCommonPac" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthTerminationCommonPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthTerminationCommonPac.body-param" + description: "tapi.eth.EthTerminationCommonPac to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthTerminationCommonPac" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthTerminationCommonPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthTerminationCommonPac.body-param" + description: "tapi.eth.EthTerminationCommonPac to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthTerminationCommonPac" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthTerminationCommonPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/eth-termination-common-pac/priority-regenerate/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.PriorityMapping" + description: "This attribute models the ETHx/ETH-m _A_Sk_MI_P_Regenerate information\ + \ defined in G.8021." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.PriorityMapping" + schema: + $ref: "#/definitions/tapi.eth.PriorityMapping" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.PriorityMapping" + description: "This attribute models the ETHx/ETH-m _A_Sk_MI_P_Regenerate information\ + \ defined in G.8021." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.eth.PriorityMapping.body-param" + description: "tapi.eth.PriorityMapping to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.PriorityMapping" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.PriorityMapping" + description: "This attribute models the ETHx/ETH-m _A_Sk_MI_P_Regenerate information\ + \ defined in G.8021." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.eth.PriorityMapping.body-param" + description: "tapi.eth.PriorityMapping to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.PriorityMapping" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.PriorityMapping" + description: "This attribute models the ETHx/ETH-m _A_Sk_MI_P_Regenerate information\ + \ defined in G.8021." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/eth-connectivity-service-end-point-spec/ety-termination-common-pac/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EtyTerminationCommonPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EtyTerminationCommonPac" + schema: + $ref: "#/definitions/tapi.eth.EtyTerminationCommonPac" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EtyTerminationCommonPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EtyTerminationCommonPac.body-param" + description: "tapi.eth.EtyTerminationCommonPac to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EtyTerminationCommonPac" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EtyTerminationCommonPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EtyTerminationCommonPac.body-param" + description: "tapi.eth.EtyTerminationCommonPac to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EtyTerminationCommonPac" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EtyTerminationCommonPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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/context/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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/server-connectivity-service-end-point/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of 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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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/context/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.ServiceInterfacePointRef" + 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.ServiceInterfacePointRef" + 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.ServiceInterfacePointRef" + 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/context/connectivity-context/connectivity-service={uuid}/eth-connectivity-service/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthConnectivityService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthConnectivityService" + schema: + $ref: "#/definitions/tapi.eth.EthConnectivityService" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthConnectivityService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthConnectivityService.body-param" + description: "tapi.eth.EthConnectivityService to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthConnectivityService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthConnectivityService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthConnectivityService.body-param" + description: "tapi.eth.EthConnectivityService to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthConnectivityService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthConnectivityService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/name/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/resilience-constraint/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.ResilienceConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.ResilienceConstraint" + schema: + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.connectivity.ResilienceConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ResilienceConstraint.body-param" + description: "tapi.connectivity.ResilienceConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.connectivity.ResilienceConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ResilienceConstraint.body-param" + description: "tapi.connectivity.ResilienceConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.connectivity.ResilienceConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.RoutingConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/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.CostCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + 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.CostCharacteristic" + 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/context/connectivity-context/connectivity-service={uuid}/routing-constraint/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.LatencyCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-connectivity" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + 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.LatencyCharacteristic" + 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/context/connectivity-context/connectivity-service={uuid}/routing-constraint/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.RiskCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/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.RiskCharacteristic" + 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.RiskCharacteristic" + 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/context/connectivity-context/connectivity-service={uuid}/topology-constraint/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.path.computation.TopologyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.path.computation.TopologyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.TopologyConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.path.computation.TopologyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.path.computation.TopologyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/name/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/name/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] + responses: + 200: + description: "tapi.notification.context.NotificationContext" + schema: + $ref: "#/definitions/tapi.notification.context.NotificationContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: + - in: "body" + name: "tapi.notification.context.NotificationContext.body-param" + description: "tapi.notification.context.NotificationContext to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.notification.context.NotificationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: + - in: "body" + name: "tapi.notification.context.NotificationContext.body-param" + description: "tapi.notification.context.NotificationContext to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.context.NotificationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - in: "body" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NotificationSubscriptionService" + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/name/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/notification-channel/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationChannel" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NotificationChannel" + schema: + $ref: "#/definitions/tapi.notification.NotificationChannel" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.Notification" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.Notification" + schema: + $ref: "#/definitions/tapi.notification.Notification" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.SubscriptionFilter" + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + 400: + description: "Internal error" + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notification={uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.notificationcontext.Notification" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.notificationcontext.Notification" + schema: + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/additional-info={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/alarm-info/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.AlarmInfo" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.AlarmInfo" + schema: + $ref: "#/definitions/tapi.oam.AlarmInfo" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.TcaInfo" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.TcaInfo" + schema: + $ref: "#/definitions/tapi.oam.TcaInfo" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/oam-job/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamJobRef" + description: "MEF 35.1\r\n Identification of the PM Session for\ + \ which the TCA Function was configured." + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamJobRef" + schema: + $ref: "#/definitions/tapi.oam.OamJobRef" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.ThresholdParameter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.ThresholdParameter" + schema: + $ref: "#/definitions/tapi.oam.ThresholdParameter" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-above-thrs/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-below-thrs/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-clear-thrs/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + /data/context/oam-context/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.context.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: [] + responses: + 200: + description: "tapi.oam.context.OamContext" + schema: + $ref: "#/definitions/tapi.oam.context.OamContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.context.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: + - in: "body" + name: "tapi.oam.context.OamContext.body-param" + description: "tapi.oam.context.OamContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.context.OamContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.context.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: + - in: "body" + name: "tapi.oam.context.OamContext.body-param" + description: "tapi.oam.context.OamContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.context.OamContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.context.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/meg={uuid}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.oamcontext.Meg" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.oamcontext.Meg" + schema: + $ref: "#/definitions/tapi.oam.oamcontext.Meg" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/eth-meg-spec/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthMegSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthMegSpec" + schema: + $ref: "#/definitions/tapi.eth.EthMegSpec" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/eth-meg-spec/eth-cfm-maintenance-association/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthCfmMaintenanceAssociation" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthCfmMaintenanceAssociation" + schema: + $ref: "#/definitions/tapi.eth.EthCfmMaintenanceAssociation" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/eth-meg-spec/eth-cfm-maintenance-association/maintenance-association-name/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.MaintenanceAssociationName" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ The Maintenance Association name and name format choice." + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.MaintenanceAssociationName" + schema: + $ref: "#/definitions/tapi.eth.MaintenanceAssociationName" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/eth-meg-spec/eth-cfm-maintenance-domain/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthCfmMaintenanceDomain" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthCfmMaintenanceDomain" + schema: + $ref: "#/definitions/tapi.eth.EthCfmMaintenanceDomain" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/eth-meg-spec/eth-meg-common/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthMegCommon" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthMegCommon" + schema: + $ref: "#/definitions/tapi.eth.EthMegCommon" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.meg.Mep" + description: "1. ME may have 0 MEPs (case of transit domains where at least\ + \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case of edge\ + \ domaind, where the peer MEP is ouside the managed domain)\r\n \ + \ 3. ME may have 2 MEPs" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.meg.Mep" + schema: + $ref: "#/definitions/tapi.oam.meg.Mep" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/eth-mep-spec/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthMepSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthMepSpec" + schema: + $ref: "#/definitions/tapi.eth.EthMepSpec" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/eth-mep-spec/eth-mep-common/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthMepCommon" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthMepCommon" + schema: + $ref: "#/definitions/tapi.eth.EthMepCommon" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/eth-mep-spec/eth-mep-sink/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthMepSink" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthMepSink" + schema: + $ref: "#/definitions/tapi.eth.EthMepSink" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/eth-mep-spec/eth-mep-sink/bandwidth-report/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.BandwidthReport" + description: "This attribute models the content of the bandwidth report received\ + \ by the MEP Sink from the peer MEP Source." + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.BandwidthReport" + schema: + $ref: "#/definitions/tapi.eth.BandwidthReport" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/eth-mep-spec/eth-mep-source/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthMepSource" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthMepSource" + schema: + $ref: "#/definitions/tapi.eth.EthMepSource" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mip={local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.meg.Mip" + description: "ME may 0, 1, or more MIPs" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.meg.Mip" + schema: + $ref: "#/definitions/tapi.oam.meg.Mip" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mip={local-id}/eth-mip-spec/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthMipSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthMipSpec" + schema: + $ref: "#/definitions/tapi.eth.EthMipSpec" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mip={local-id}/eth-mip-spec/eth-mip-common/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthMipCommon" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthMipCommon" + schema: + $ref: "#/definitions/tapi.eth.EthMipCommon" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mip={local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/oam-context/oam-job/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.oamcontext.OamJob" + description: "none" + parameters: + - in: "body" + name: "tapi.oam.oamcontext.OamJob.body-param" + description: "tapi.oam.oamcontext.OamJob to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.oamcontext.OamJob" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-job={uuid}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.oamcontext.OamJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.oamcontext.OamJob" + schema: + $ref: "#/definitions/tapi.oam.oamcontext.OamJob" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.oamcontext.OamJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.oam.oamcontext.OamJob.body-param" + description: "tapi.oam.oamcontext.OamJob to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.oamcontext.OamJob" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.oamcontext.OamJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.oamjob.CurrentData" + description: "Granularity period of the CurrentData identifies the specific\ + \ CurrentData instance in the scope of this OamJob.\r\n For\ + \ example, typically at least\r\n one 15min and\r\n \ + \ one 24hr;\r\n optionally one additional configurable\ + \ (< 15min)" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.oamjob.CurrentData" + schema: + $ref: "#/definitions/tapi.oam.oamjob.CurrentData" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/elapsed-time/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimeInterval" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimeInterval" + schema: + $ref: "#/definitions/tapi.common.TimeInterval" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/elapsed-time/period={unit}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "unit" + in: "path" + description: "Id of period" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimePeriod" + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-link-trace-result-data/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthLinkTraceResultData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthLinkTraceResultData" + schema: + $ref: "#/definitions/tapi.eth.EthLinkTraceResultData" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-link-trace-result-data/eth-cfm-link-trace-result-data={seq-number}/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthCfmLinkTraceResultData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "seq-number" + in: "path" + description: "Id of eth-cfm-link-trace-result-data" + required: true + type: "integer" + format: "int32" + responses: + 200: + description: "tapi.eth.EthCfmLinkTraceResultData" + schema: + $ref: "#/definitions/tapi.eth.EthCfmLinkTraceResultData" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-link-trace-result-data/eth-cfm-link-trace-result-data={seq-number}/chassis-id/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.LldpChassisIdSubtype" + description: "MEF 38:\r\n The chassis-id-subtype contains the\ + \ chassis ID entity that is listed in the chassis ID field. This is a combination\ + \ of the 'Chassis ID Subtype' and 'chsssis ID' fields.\r\n \ + \ IEEE P802.1Qcx/D0.3:\r\n The Chassis ID returned in the Sender\ + \ ID TLV of the LTR, if any.\r\n The format of a chassis identifier\ + \ string. Objects of this type are always used with an associated lldp-chassis-is-subtype\ + \ object, which identifies the format of the particular lldp-chassis-id object\ + \ instance.\r\n If the associated lldp-chassis-id-subtype object\ + \ has a value of chassis-component, then the octet string identifies a particular\ + \ instance of the entPhysicalAlias object (defined in IETF RFC 2737) for a\ + \ chassis component (i.e., an entPhysicalClass value of chassis(3)).\r\n \ + \ If the associated lldp-chassis-id-subtype object has a value\ + \ of interface-alias, then the octet string identifies a particular instance\ + \ of the ifAlias object (defined in IETF RFC 2863) for an interface on the\ + \ containing chassis.\r\n If the particular ifAlias object\ + \ does not contain any values, another chassis identifier type should be used." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "seq-number" + in: "path" + description: "Id of eth-cfm-link-trace-result-data" + required: true + type: "integer" + format: "int32" + responses: + 200: + description: "tapi.eth.LldpChassisIdSubtype" + schema: + $ref: "#/definitions/tapi.eth.LldpChassisIdSubtype" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-link-trace-result-data/eth-cfm-link-trace-result-data={seq-number}/egress-port-id/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.LldpPortIdSubtype" + description: "MEF 38:\r\n IEEE P802.1Qcx/D0.3:\r\n \ + \ Egress Port ID.\r\n IEEE P802.1Qcx/D0.3:\r\n \ + \ If the egressActionField attribute contains the value EGRESS-NO-TLV,\ + \ then the contents of this attribute are meaningless." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "seq-number" + in: "path" + description: "Id of eth-cfm-link-trace-result-data" + required: true + type: "integer" + format: "int32" + responses: + 200: + description: "tapi.eth.LldpPortIdSubtype" + schema: + $ref: "#/definitions/tapi.eth.LldpPortIdSubtype" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-link-trace-result-data/eth-cfm-link-trace-result-data={seq-number}/ingress-port-id/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.LldpPortIdSubtype" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ Ingress Port ID.\r\n IEEE P802.1Qcx/D0.3:\r\n \ + \ If the ingressActionField attribute contains the value INGRESS-NO-TLV,\ + \ then the contents of this attribute are meaningless." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "seq-number" + in: "path" + description: "Id of eth-cfm-link-trace-result-data" + required: true + type: "integer" + format: "int32" + responses: + 200: + description: "tapi.eth.LldpPortIdSubtype" + schema: + $ref: "#/definitions/tapi.eth.LldpPortIdSubtype" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-link-trace-result-data/result-list={source-address}/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.LinkTraceResult" + description: "G.8052: This parameter returns the results of the LT process.\ + \ It contains a list of the result received from the individual LTR frames.\r\ + \n The result from the individual LTR frame include the Source\ + \ Mac Address, the TTL, and TLV." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "source-address" + in: "path" + description: "Id of result-list" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.LinkTraceResult" + schema: + $ref: "#/definitions/tapi.eth.LinkTraceResult" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-loopback-result-data/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthLoopbackResultData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthLoopbackResultData" + schema: + $ref: "#/definitions/tapi.eth.EthLoopbackResultData" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-1-dm-performance-data/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthOnDemand1DmPerformanceData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthOnDemand1DmPerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthOnDemand1DmPerformanceData" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-1-dm-performance-data/samples-near-end-1-dm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.SamplesDmPerformanceParameters" + description: "This attribute contains the results of an on-demand frame delay\ + \ measurement job in the ingress direction." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.SamplesDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.SamplesDmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-1-dm-performance-data/statistical-near-end-1-dm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.StatisticalDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-1-dm-source-performance-data/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthOnDemand1DmSourcePerformanceData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthOnDemand1DmSourcePerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthOnDemand1DmSourcePerformanceData" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-1-lm-performance-data/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthOnDemand1LmPerformanceData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthOnDemand1LmPerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthOnDemand1LmPerformanceData" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-1-lm-performance-data/statistical-near-end-1-lm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.StatisticalLmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.StatisticalLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-1-lm-performance-data/total-counters-near-end-1-lm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.TotalCountersLmPerformanceParameters" + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the ingress direction." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.TotalCountersLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-1-lm-source-performance-data/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthOnDemand1LmSourcePerformanceData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthOnDemand1LmSourcePerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthOnDemand1LmSourcePerformanceData" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-dm-performance-data/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthOnDemandDmPerformanceData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthOnDemandDmPerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthOnDemandDmPerformanceData" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-dm-performance-data/samples-far-end-dm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.SamplesDmPerformanceParameters" + description: "This attribute contains the results of an on-demand frame delay\ + \ measurement job in the ingress direction." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.SamplesDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.SamplesDmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-dm-performance-data/samples-near-end-dm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.SamplesDmPerformanceParameters" + description: "This attribute contains the results of an on-demand frame delay\ + \ measurement job in the ingress direction." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.SamplesDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.SamplesDmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-dm-performance-data/statistical-bi-dir-dm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical bidirectional performnace\ + \ parameters." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.StatisticalDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-dm-performance-data/statistical-far-end-dm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical far end performnace parameters." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.StatisticalDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-dm-performance-data/statistical-near-end-dm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.StatisticalDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-lm-performance-data/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthOnDemandLmPerformanceData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthOnDemandLmPerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthOnDemandLmPerformanceData" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-lm-performance-data/statistical-far-end-lm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.StatisticalLmPerformanceParameters" + description: "This attribute contains the statistical far end performnace parameters." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.StatisticalLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-lm-performance-data/statistical-near-end-lm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.StatisticalLmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.StatisticalLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-lm-performance-data/total-counters-far-end-lm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.TotalCountersLmPerformanceParameters" + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the egress direction." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.TotalCountersLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-on-demand-lm-performance-data/total-counters-near-end-lm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.TotalCountersLmPerformanceParameters" + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the ingress direction." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.TotalCountersLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-1-dm-performance-data/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthProActive1DmPerformanceData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthProActive1DmPerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthProActive1DmPerformanceData" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-1-dm-performance-data/statistical-near-end-1-dm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.StatisticalDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-1-dm-source-performance-data/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthProActive1DmSourcePerformanceData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthProActive1DmSourcePerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthProActive1DmSourcePerformanceData" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-1-lm-performance-data/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthProActive1LmPerformanceData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthProActive1LmPerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthProActive1LmPerformanceData" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-1-lm-performance-data/statistical-near-end-1-lm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.StatisticalLmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.StatisticalLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-1-lm-performance-data/total-counters-near-end-1-lm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.TotalCountersLmPerformanceParameters" + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the ingress direction." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.TotalCountersLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-1-lm-source-performance-data/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthProActive1LmSourcePerformanceData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthProActive1LmSourcePerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthProActive1LmSourcePerformanceData" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-dm-performance-data/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthProActiveDmPerformanceData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthProActiveDmPerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthProActiveDmPerformanceData" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-dm-performance-data/statistical-bi-dir-dm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical bidirectional performnace\ + \ parameters." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.StatisticalDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-dm-performance-data/statistical-far-end-dm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical far end performnace parameters." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.StatisticalDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-dm-performance-data/statistical-near-end-dm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.StatisticalDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-lm-performance-data/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthProActiveLmPerformanceData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthProActiveLmPerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthProActiveLmPerformanceData" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-lm-performance-data/statistical-far-end-lm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.StatisticalLmPerformanceParameters" + description: "This attribute contains the statistical far end performnace parameters." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.StatisticalLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-lm-performance-data/statistical-near-end-lm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.StatisticalLmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.StatisticalLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-lm-performance-data/total-counters-far-end-lm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.TotalCountersLmPerformanceParameters" + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the egress direction." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.TotalCountersLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-pro-active-lm-performance-data/total-counters-near-end-lm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.TotalCountersLmPerformanceParameters" + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the ingress direction." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.TotalCountersLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/eth-test-result-data/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthTestResultData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthTestResultData" + schema: + $ref: "#/definitions/tapi.eth.EthTestResultData" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.currentdata.HistoryData" + description: "in case of 24hr Current Data, at least 1 History Data.\r\n \ + \ In case of 15min Current Data, at least 16 History Data.\r\n\ + \ In case of <15min, the number of History Data shall be able\ + \ to cover a span of 4 hours." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.currentdata.HistoryData" + schema: + $ref: "#/definitions/tapi.oam.currentdata.HistoryData" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-1-dm-performance-data/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthOnDemand1DmPerformanceData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthOnDemand1DmPerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthOnDemand1DmPerformanceData" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-1-dm-performance-data/samples-near-end-1-dm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.SamplesDmPerformanceParameters" + description: "This attribute contains the results of an on-demand frame delay\ + \ measurement job in the ingress direction." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.SamplesDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.SamplesDmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-1-dm-performance-data/statistical-near-end-1-dm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.StatisticalDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-1-dm-source-performance-data/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthOnDemand1DmSourcePerformanceData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthOnDemand1DmSourcePerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthOnDemand1DmSourcePerformanceData" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-1-lm-performance-data/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthOnDemand1LmPerformanceData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthOnDemand1LmPerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthOnDemand1LmPerformanceData" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-1-lm-performance-data/statistical-near-end-1-lm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.StatisticalLmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.StatisticalLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-1-lm-performance-data/total-counters-near-end-1-lm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.TotalCountersLmPerformanceParameters" + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the ingress direction." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.TotalCountersLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-1-lm-source-performance-data/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthOnDemand1LmSourcePerformanceData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthOnDemand1LmSourcePerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthOnDemand1LmSourcePerformanceData" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-dm-performance-data/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthOnDemandDmPerformanceData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthOnDemandDmPerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthOnDemandDmPerformanceData" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-dm-performance-data/samples-far-end-dm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.SamplesDmPerformanceParameters" + description: "This attribute contains the results of an on-demand frame delay\ + \ measurement job in the ingress direction." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.SamplesDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.SamplesDmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-dm-performance-data/samples-near-end-dm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.SamplesDmPerformanceParameters" + description: "This attribute contains the results of an on-demand frame delay\ + \ measurement job in the ingress direction." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.SamplesDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.SamplesDmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-dm-performance-data/statistical-bi-dir-dm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical bidirectional performnace\ + \ parameters." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.StatisticalDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-dm-performance-data/statistical-far-end-dm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical far end performnace parameters." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.StatisticalDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-dm-performance-data/statistical-near-end-dm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.StatisticalDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-lm-performance-data/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthOnDemandLmPerformanceData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthOnDemandLmPerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthOnDemandLmPerformanceData" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-lm-performance-data/statistical-far-end-lm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.StatisticalLmPerformanceParameters" + description: "This attribute contains the statistical far end performnace parameters." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.StatisticalLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-lm-performance-data/statistical-near-end-lm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.StatisticalLmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.StatisticalLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-lm-performance-data/total-counters-far-end-lm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.TotalCountersLmPerformanceParameters" + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the egress direction." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.TotalCountersLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-on-demand-lm-performance-data/total-counters-near-end-lm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.TotalCountersLmPerformanceParameters" + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the ingress direction." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.TotalCountersLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-1-dm-performance-data/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthProActive1DmPerformanceData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthProActive1DmPerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthProActive1DmPerformanceData" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-1-dm-performance-data/statistical-near-end-1-dm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.StatisticalDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-1-dm-source-performance-data/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthProActive1DmSourcePerformanceData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthProActive1DmSourcePerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthProActive1DmSourcePerformanceData" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-1-lm-performance-data/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthProActive1LmPerformanceData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthProActive1LmPerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthProActive1LmPerformanceData" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-1-lm-performance-data/statistical-near-end-1-lm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.StatisticalLmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.StatisticalLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-1-lm-performance-data/total-counters-near-end-1-lm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.TotalCountersLmPerformanceParameters" + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the ingress direction." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.TotalCountersLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-1-lm-source-performance-data/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthProActive1LmSourcePerformanceData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthProActive1LmSourcePerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthProActive1LmSourcePerformanceData" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-dm-performance-data/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthProActiveDmPerformanceData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthProActiveDmPerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthProActiveDmPerformanceData" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-dm-performance-data/statistical-bi-dir-dm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical bidirectional performnace\ + \ parameters." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.StatisticalDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-dm-performance-data/statistical-far-end-dm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical far end performnace parameters." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.StatisticalDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-dm-performance-data/statistical-near-end-dm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.StatisticalDmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.StatisticalDmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-lm-performance-data/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthProActiveLmPerformanceData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthProActiveLmPerformanceData" + schema: + $ref: "#/definitions/tapi.eth.EthProActiveLmPerformanceData" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-lm-performance-data/statistical-far-end-lm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.StatisticalLmPerformanceParameters" + description: "This attribute contains the statistical far end performnace parameters." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.StatisticalLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-lm-performance-data/statistical-near-end-lm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.StatisticalLmPerformanceParameters" + description: "This attribute contains the statistical near end performnace parameters." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.StatisticalLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-lm-performance-data/total-counters-far-end-lm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.TotalCountersLmPerformanceParameters" + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the egress direction." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.TotalCountersLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/eth-pro-active-lm-performance-data/total-counters-near-end-lm-parameters/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.TotalCountersLmPerformanceParameters" + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the ingress direction." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.TotalCountersLmPerformanceParameters" + schema: + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/pm-data-pac/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmDataPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmDataPac" + schema: + $ref: "#/definitions/tapi.oam.PmDataPac" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/pm-data-pac/granularity-period/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimePeriod" + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/pm-data-pac/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmDataPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmDataPac" + schema: + $ref: "#/definitions/tapi.oam.PmDataPac" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/pm-data-pac/granularity-period/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimePeriod" + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/eth-link-trace-job/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthLinkTraceJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthLinkTraceJob" + schema: + $ref: "#/definitions/tapi.eth.EthLinkTraceJob" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthLinkTraceJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthLinkTraceJob.body-param" + description: "tapi.eth.EthLinkTraceJob to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthLinkTraceJob" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthLinkTraceJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthLinkTraceJob.body-param" + description: "tapi.eth.EthLinkTraceJob to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthLinkTraceJob" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthLinkTraceJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/eth-link-trace-job/eth-cfm-link-trace-pac/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthCfmLinkTracePac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthCfmLinkTracePac" + schema: + $ref: "#/definitions/tapi.eth.EthCfmLinkTracePac" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthCfmLinkTracePac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthCfmLinkTracePac.body-param" + description: "tapi.eth.EthCfmLinkTracePac to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthCfmLinkTracePac" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthCfmLinkTracePac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthCfmLinkTracePac.body-param" + description: "tapi.eth.EthCfmLinkTracePac to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthCfmLinkTracePac" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthCfmLinkTracePac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/eth-loopback-job/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthLoopbackJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthLoopbackJob" + schema: + $ref: "#/definitions/tapi.eth.EthLoopbackJob" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthLoopbackJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthLoopbackJob.body-param" + description: "tapi.eth.EthLoopbackJob to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthLoopbackJob" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthLoopbackJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthLoopbackJob.body-param" + description: "tapi.eth.EthLoopbackJob to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthLoopbackJob" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthLoopbackJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/eth-loopback-job/eth-oam-test-loopback-common-pac/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthOamTestLoopbackCommonPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthOamTestLoopbackCommonPac" + schema: + $ref: "#/definitions/tapi.eth.EthOamTestLoopbackCommonPac" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthOamTestLoopbackCommonPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthOamTestLoopbackCommonPac.body-param" + description: "tapi.eth.EthOamTestLoopbackCommonPac to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthOamTestLoopbackCommonPac" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthOamTestLoopbackCommonPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthOamTestLoopbackCommonPac.body-param" + description: "tapi.eth.EthOamTestLoopbackCommonPac to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthOamTestLoopbackCommonPac" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthOamTestLoopbackCommonPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/eth-on-demand-dual-ended-measurement-job/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthOnDemandDualEndedMeasurementJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthOnDemandDualEndedMeasurementJob" + schema: + $ref: "#/definitions/tapi.eth.EthOnDemandDualEndedMeasurementJob" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthOnDemandDualEndedMeasurementJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthOnDemandDualEndedMeasurementJob.body-param" + description: "tapi.eth.EthOnDemandDualEndedMeasurementJob to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthOnDemandDualEndedMeasurementJob" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthOnDemandDualEndedMeasurementJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthOnDemandDualEndedMeasurementJob.body-param" + description: "tapi.eth.EthOnDemandDualEndedMeasurementJob to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthOnDemandDualEndedMeasurementJob" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthOnDemandDualEndedMeasurementJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/eth-on-demand-dual-ended-measurement-job/eth-on-demand-measurement-job-control-sink/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthOnDemandMeasurementJobControlSink" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthOnDemandMeasurementJobControlSink" + schema: + $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSink" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthOnDemandMeasurementJobControlSink" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthOnDemandMeasurementJobControlSink.body-param" + description: "tapi.eth.EthOnDemandMeasurementJobControlSink to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSink" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthOnDemandMeasurementJobControlSink" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthOnDemandMeasurementJobControlSink.body-param" + description: "tapi.eth.EthOnDemandMeasurementJobControlSink to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSink" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthOnDemandMeasurementJobControlSink" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/eth-on-demand-dual-ended-measurement-job/eth-on-demand-measurement-job-control-source/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthOnDemandMeasurementJobControlSource" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthOnDemandMeasurementJobControlSource" + schema: + $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthOnDemandMeasurementJobControlSource" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthOnDemandMeasurementJobControlSource.body-param" + description: "tapi.eth.EthOnDemandMeasurementJobControlSource to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthOnDemandMeasurementJobControlSource" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthOnDemandMeasurementJobControlSource.body-param" + description: "tapi.eth.EthOnDemandMeasurementJobControlSource to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthOnDemandMeasurementJobControlSource" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/eth-on-demand-single-ended-measurement-job/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthOnDemandSingleEndedMeasurementJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthOnDemandSingleEndedMeasurementJob" + schema: + $ref: "#/definitions/tapi.eth.EthOnDemandSingleEndedMeasurementJob" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthOnDemandSingleEndedMeasurementJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthOnDemandSingleEndedMeasurementJob.body-param" + description: "tapi.eth.EthOnDemandSingleEndedMeasurementJob to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthOnDemandSingleEndedMeasurementJob" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthOnDemandSingleEndedMeasurementJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthOnDemandSingleEndedMeasurementJob.body-param" + description: "tapi.eth.EthOnDemandSingleEndedMeasurementJob to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthOnDemandSingleEndedMeasurementJob" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthOnDemandSingleEndedMeasurementJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/oam-context/oam-job={uuid}/eth-on-demand-single-ended-measurement-job/eth-on-demand-measurement-job-control-source/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthOnDemandMeasurementJobControlSource" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthOnDemandMeasurementJobControlSource" + schema: + $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthOnDemandMeasurementJobControlSource" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthOnDemandMeasurementJobControlSource.body-param" + description: "tapi.eth.EthOnDemandMeasurementJobControlSource to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthOnDemandMeasurementJobControlSource" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthOnDemandMeasurementJobControlSource.body-param" + description: "tapi.eth.EthOnDemandMeasurementJobControlSource to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthOnDemandMeasurementJobControlSource" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/eth-pro-active-dual-ended-measurement-job/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthProActiveDualEndedMeasurementJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthProActiveDualEndedMeasurementJob" + schema: + $ref: "#/definitions/tapi.eth.EthProActiveDualEndedMeasurementJob" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthProActiveDualEndedMeasurementJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthProActiveDualEndedMeasurementJob.body-param" + description: "tapi.eth.EthProActiveDualEndedMeasurementJob to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthProActiveDualEndedMeasurementJob" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthProActiveDualEndedMeasurementJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthProActiveDualEndedMeasurementJob.body-param" + description: "tapi.eth.EthProActiveDualEndedMeasurementJob to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthProActiveDualEndedMeasurementJob" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthProActiveDualEndedMeasurementJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/eth-pro-active-dual-ended-measurement-job/eth-pro-active-measurement-job-control-sink/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthProActiveMeasurementJobControlSink" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthProActiveMeasurementJobControlSink" + schema: + $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSink" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthProActiveMeasurementJobControlSink" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthProActiveMeasurementJobControlSink.body-param" + description: "tapi.eth.EthProActiveMeasurementJobControlSink to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSink" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthProActiveMeasurementJobControlSink" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthProActiveMeasurementJobControlSink.body-param" + description: "tapi.eth.EthProActiveMeasurementJobControlSink to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSink" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthProActiveMeasurementJobControlSink" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/oam-context/oam-job={uuid}/eth-pro-active-dual-ended-measurement-job/eth-pro-active-measurement-job-control-source/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthProActiveMeasurementJobControlSource" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthProActiveMeasurementJobControlSource" + schema: + $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthProActiveMeasurementJobControlSource" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthProActiveMeasurementJobControlSource.body-param" + description: "tapi.eth.EthProActiveMeasurementJobControlSource to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthProActiveMeasurementJobControlSource" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthProActiveMeasurementJobControlSource.body-param" + description: "tapi.eth.EthProActiveMeasurementJobControlSource to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthProActiveMeasurementJobControlSource" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/eth-pro-active-single-ended-measurement-job/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthProActiveSingleEndedMeasurementJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthProActiveSingleEndedMeasurementJob" + schema: + $ref: "#/definitions/tapi.eth.EthProActiveSingleEndedMeasurementJob" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthProActiveSingleEndedMeasurementJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthProActiveSingleEndedMeasurementJob.body-param" + description: "tapi.eth.EthProActiveSingleEndedMeasurementJob to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthProActiveSingleEndedMeasurementJob" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthProActiveSingleEndedMeasurementJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthProActiveSingleEndedMeasurementJob.body-param" + description: "tapi.eth.EthProActiveSingleEndedMeasurementJob to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthProActiveSingleEndedMeasurementJob" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthProActiveSingleEndedMeasurementJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/oam-context/oam-job={uuid}/eth-pro-active-single-ended-measurement-job/eth-pro-active-measurement-job-control-source/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthProActiveMeasurementJobControlSource" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthProActiveMeasurementJobControlSource" + schema: + $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthProActiveMeasurementJobControlSource" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthProActiveMeasurementJobControlSource.body-param" + description: "tapi.eth.EthProActiveMeasurementJobControlSource to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthProActiveMeasurementJobControlSource" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthProActiveMeasurementJobControlSource.body-param" + description: "tapi.eth.EthProActiveMeasurementJobControlSource to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthProActiveMeasurementJobControlSource" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/eth-test-job/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthTestJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthTestJob" + schema: + $ref: "#/definitions/tapi.eth.EthTestJob" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthTestJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthTestJob.body-param" + description: "tapi.eth.EthTestJob to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthTestJob" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthTestJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthTestJob.body-param" + description: "tapi.eth.EthTestJob to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthTestJob" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthTestJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/eth-test-job/eth-oam-test-loopback-common-pac/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthOamTestLoopbackCommonPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthOamTestLoopbackCommonPac" + schema: + $ref: "#/definitions/tapi.eth.EthOamTestLoopbackCommonPac" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthOamTestLoopbackCommonPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthOamTestLoopbackCommonPac.body-param" + description: "tapi.eth.EthOamTestLoopbackCommonPac to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthOamTestLoopbackCommonPac" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthOamTestLoopbackCommonPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthOamTestLoopbackCommonPac.body-param" + description: "tapi.eth.EthOamTestLoopbackCommonPac to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthOamTestLoopbackCommonPac" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthOamTestLoopbackCommonPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/eth-test-job/eth-test-job-sink-point/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthTestJobSinkPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthTestJobSinkPoint" + schema: + $ref: "#/definitions/tapi.eth.EthTestJobSinkPoint" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthTestJobSinkPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthTestJobSinkPoint.body-param" + description: "tapi.eth.EthTestJobSinkPoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthTestJobSinkPoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthTestJobSinkPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthTestJobSinkPoint.body-param" + description: "tapi.eth.EthTestJobSinkPoint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthTestJobSinkPoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthTestJobSinkPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-job={uuid}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/oam-profile/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamProfileRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamProfileRef" + schema: + $ref: "#/definitions/tapi.oam.OamProfileRef" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamProfileRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamProfileRef.body-param" + description: "tapi.oam.OamProfileRef to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfileRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamProfileRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamProfileRef.body-param" + description: "tapi.oam.OamProfileRef to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfileRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamProfileRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamServicePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamServicePointRef.body-param" + description: "tapi.oam.OamServicePointRef to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamServicePointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-job={uuid}/oam-service-point={oam-service-uuid},{oam-service-point-local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamServicePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "oam-service-uuid" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "oam-service-point-local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamServicePointRef" + schema: + $ref: "#/definitions/tapi.oam.OamServicePointRef" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamServicePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "oam-service-uuid" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "oam-service-point-local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamServicePointRef.body-param" + description: "tapi.oam.OamServicePointRef to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamServicePointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamServicePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "oam-service-uuid" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "oam-service-point-local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/schedule/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimeRange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimeRange" + schema: + $ref: "#/definitions/tapi.common.TimeRange" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.TimeRange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.TimeRange" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.TimeRange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.TimeRange" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.TimeRange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamProfile" + description: "none" + parameters: + - in: "body" + name: "tapi.oam.OamProfile.body-param" + description: "tapi.oam.OamProfile to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfile" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamProfile" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamProfile" + schema: + $ref: "#/definitions/tapi.oam.OamProfile" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamProfile" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamProfile.body-param" + description: "tapi.oam.OamProfile to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfile" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamProfile" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.PmThresholdData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmThresholdData.body-param" + description: "tapi.oam.PmThresholdData to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmThresholdData" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmThresholdData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmThresholdData" + schema: + $ref: "#/definitions/tapi.oam.PmThresholdData" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.PmThresholdData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmThresholdData.body-param" + description: "tapi.oam.PmThresholdData to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmThresholdData" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.PmThresholdData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/granularity-period/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimePeriod" + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - in: "body" + name: "tapi.common.TimePeriod.body-param" + description: "tapi.common.TimePeriod to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - in: "body" + name: "tapi.common.TimePeriod.body-param" + description: "tapi.common.TimePeriod to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.ThresholdParameter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - in: "body" + name: "tapi.oam.ThresholdParameter.body-param" + description: "tapi.oam.ThresholdParameter to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.ThresholdParameter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.ThresholdParameter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.ThresholdParameter" + schema: + $ref: "#/definitions/tapi.oam.ThresholdParameter" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.ThresholdParameter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.ThresholdParameter.body-param" + description: "tapi.oam.ThresholdParameter to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.ThresholdParameter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.ThresholdParameter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-above-thrs/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-below-thrs/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-clear-thrs/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.oamcontext.OamService" + description: "none" + parameters: + - in: "body" + name: "tapi.oam.oamcontext.OamService.body-param" + description: "tapi.oam.oamcontext.OamService to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.oamcontext.OamService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-service={uuid}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.oamcontext.OamService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.oamcontext.OamService" + schema: + $ref: "#/definitions/tapi.oam.oamcontext.OamService" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.oamcontext.OamService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - in: "body" + name: "tapi.oam.oamcontext.OamService.body-param" + description: "tapi.oam.oamcontext.OamService to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.oamcontext.OamService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.oamcontext.OamService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/eth-oam-service/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthOamService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthOamService" + schema: + $ref: "#/definitions/tapi.eth.EthOamService" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthOamService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthOamService.body-param" + description: "tapi.eth.EthOamService to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthOamService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthOamService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthOamService.body-param" + description: "tapi.eth.EthOamService to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthOamService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthOamService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/eth-oam-service/eth-cfm-maintenance-association/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthCfmMaintenanceAssociation" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthCfmMaintenanceAssociation" + schema: + $ref: "#/definitions/tapi.eth.EthCfmMaintenanceAssociation" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthCfmMaintenanceAssociation" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthCfmMaintenanceAssociation.body-param" + description: "tapi.eth.EthCfmMaintenanceAssociation to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthCfmMaintenanceAssociation" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthCfmMaintenanceAssociation" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthCfmMaintenanceAssociation.body-param" + description: "tapi.eth.EthCfmMaintenanceAssociation to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthCfmMaintenanceAssociation" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthCfmMaintenanceAssociation" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/eth-oam-service/eth-cfm-maintenance-association/maintenance-association-name/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.MaintenanceAssociationName" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ The Maintenance Association name and name format choice." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.MaintenanceAssociationName" + schema: + $ref: "#/definitions/tapi.eth.MaintenanceAssociationName" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.MaintenanceAssociationName" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ The Maintenance Association name and name format choice." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - in: "body" + name: "tapi.eth.MaintenanceAssociationName.body-param" + description: "tapi.eth.MaintenanceAssociationName to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.MaintenanceAssociationName" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.MaintenanceAssociationName" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ The Maintenance Association name and name format choice." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - in: "body" + name: "tapi.eth.MaintenanceAssociationName.body-param" + description: "tapi.eth.MaintenanceAssociationName to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.MaintenanceAssociationName" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.MaintenanceAssociationName" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ The Maintenance Association name and name format choice." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/eth-oam-service/eth-cfm-maintenance-domain/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthCfmMaintenanceDomain" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthCfmMaintenanceDomain" + schema: + $ref: "#/definitions/tapi.eth.EthCfmMaintenanceDomain" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthCfmMaintenanceDomain" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthCfmMaintenanceDomain.body-param" + description: "tapi.eth.EthCfmMaintenanceDomain to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthCfmMaintenanceDomain" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthCfmMaintenanceDomain" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthCfmMaintenanceDomain.body-param" + description: "tapi.eth.EthCfmMaintenanceDomain to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthCfmMaintenanceDomain" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthCfmMaintenanceDomain" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/eth-oam-service/eth-meg-common/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthMegCommon" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthMegCommon" + schema: + $ref: "#/definitions/tapi.eth.EthMegCommon" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthMegCommon" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthMegCommon.body-param" + description: "tapi.eth.EthMegCommon to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthMegCommon" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthMegCommon" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthMegCommon.body-param" + description: "tapi.eth.EthMegCommon to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthMegCommon" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthMegCommon" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/meg/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MegRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MegRef" + schema: + $ref: "#/definitions/tapi.oam.MegRef" + 400: + description: "Internal error" + /data/context/oam-context/oam-service={uuid}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-service={uuid}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.oamservice.OamServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - in: "body" + name: "tapi.oam.oamservice.OamServicePoint.body-param" + description: "tapi.oam.oamservice.OamServicePoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.oamservice.OamServicePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.oamservice.OamServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.oamservice.OamServicePoint" + schema: + $ref: "#/definitions/tapi.oam.oamservice.OamServicePoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.oamservice.OamServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.oam.oamservice.OamServicePoint.body-param" + description: "tapi.oam.oamservice.OamServicePoint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.oamservice.OamServicePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.oamservice.OamServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/connectivity-service-end-point/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.ConnectivityServiceEndPointRef" + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/eth-oam-mep-service-point/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthOamMepServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthOamMepServicePoint" + schema: + $ref: "#/definitions/tapi.eth.EthOamMepServicePoint" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthOamMepServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthOamMepServicePoint.body-param" + description: "tapi.eth.EthOamMepServicePoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthOamMepServicePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthOamMepServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthOamMepServicePoint.body-param" + description: "tapi.eth.EthOamMepServicePoint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthOamMepServicePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthOamMepServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/eth-oam-mep-service-point/eth-mep-common/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthMepCommon" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthMepCommon" + schema: + $ref: "#/definitions/tapi.eth.EthMepCommon" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthMepCommon" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthMepCommon.body-param" + description: "tapi.eth.EthMepCommon to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthMepCommon" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthMepCommon" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthMepCommon.body-param" + description: "tapi.eth.EthMepCommon to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthMepCommon" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthMepCommon" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/eth-oam-mep-service-point/eth-mep-sink/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthMepSink" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthMepSink" + schema: + $ref: "#/definitions/tapi.eth.EthMepSink" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthMepSink" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthMepSink.body-param" + description: "tapi.eth.EthMepSink to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthMepSink" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthMepSink" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthMepSink.body-param" + description: "tapi.eth.EthMepSink to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthMepSink" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthMepSink" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/eth-oam-mep-service-point/eth-mep-sink/bandwidth-report/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.BandwidthReport" + description: "This attribute models the content of the bandwidth report received\ + \ by the MEP Sink from the peer MEP Source." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.BandwidthReport" + schema: + $ref: "#/definitions/tapi.eth.BandwidthReport" + 400: + description: "Internal error" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/eth-oam-mep-service-point/eth-mep-source/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthMepSource" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthMepSource" + schema: + $ref: "#/definitions/tapi.eth.EthMepSource" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthMepSource" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthMepSource.body-param" + description: "tapi.eth.EthMepSource to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthMepSource" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthMepSource" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthMepSource.body-param" + description: "tapi.eth.EthMepSource to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthMepSource" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthMepSource" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/eth-oam-mip-service-point/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthOamMipServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthOamMipServicePoint" + schema: + $ref: "#/definitions/tapi.eth.EthOamMipServicePoint" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthOamMipServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthOamMipServicePoint.body-param" + description: "tapi.eth.EthOamMipServicePoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthOamMipServicePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthOamMipServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthOamMipServicePoint.body-param" + description: "tapi.eth.EthOamMipServicePoint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthOamMipServicePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthOamMipServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/eth-oam-mip-service-point/eth-mip-common/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthMipCommon" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthMipCommon" + schema: + $ref: "#/definitions/tapi.eth.EthMipCommon" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthMipCommon" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthMipCommon.body-param" + description: "tapi.eth.EthMipCommon to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthMipCommon" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthMipCommon" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthMipCommon.body-param" + description: "tapi.eth.EthMipCommon to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthMipCommon" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthMipCommon" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/mep/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MepRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MepRef" + schema: + $ref: "#/definitions/tapi.oam.MepRef" + 400: + description: "Internal error" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/mip/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MipRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MipRef" + schema: + $ref: "#/definitions/tapi.oam.MipRef" + 400: + description: "Internal error" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/service-interface-point/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePointRef" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: [] + responses: + 200: + description: "tapi.path.computation.PathComputationContext" + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: + - in: "body" + name: "tapi.path.computation.PathComputationContext.body-param" + description: "tapi.path.computation.PathComputationContext to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: + - in: "body" + name: "tapi.path.computation.PathComputationContext.body-param" + description: "tapi.path.computation.PathComputationContext to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathComputationService" + description: "none" + parameters: + - in: "body" + name: "tapi.path.computation.PathComputationService.body-param" + description: "tapi.path.computation.PathComputationService to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathComputationService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.PathComputationService" + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationService" + 400: + description: "Internal error" + 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.PathComputationService" + 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/context/path-computation-context/path-comp-service={uuid}/end-point/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathServiceEndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.PathServiceEndPoint.body-param" + description: "tapi.path.computation.PathServiceEndPoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathServiceEndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.PathServiceEndPoint" + schema: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-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.PathServiceEndPoint" + 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/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of 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.Capacity" + 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.Capacity" + 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.Capacity" + 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/context/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.CapacityValue" + 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.CapacityValue" + 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.CapacityValue" + 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/context/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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/service-interface-point/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePointRef" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 400: + description: "Internal error" + post: + tags: + - "tapi-path-computation" + 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.ServiceInterfacePointRef" + 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.ServiceInterfacePointRef" + 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/context/path-computation-context/path-comp-service={uuid}/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/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.PathObjectiveFunction" + 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.PathObjectiveFunction" + 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.PathObjectiveFunction" + 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/context/path-computation-context/path-comp-service={uuid}/objective-function/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/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.PathOptimizationConstraint" + 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.PathOptimizationConstraint" + 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.PathOptimizationConstraint" + 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/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/path={path-uuid}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "path-uuid" + in: "path" + description: "Id of path" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.PathRef" + schema: + $ref: "#/definitions/tapi.path.computation.PathRef" + 400: + description: "Internal error" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.RoutingConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + 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.CostCharacteristic" + 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/context/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.LatencyCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-path-computation" + 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.LatencyCharacteristic" + 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.LatencyCharacteristic" + 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/context/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.RiskCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-path-computation" + 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.RiskCharacteristic" + 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.RiskCharacteristic" + 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/context/path-computation-context/path-comp-service={uuid}/topology-constraint/: + 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.TopologyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/: + 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" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.TopologyConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + 400: + description: "Internal error" + put: + tags: + - "tapi-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" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object 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" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/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.Path" + 400: + description: "Internal error" + /data/context/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.LinkRef" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/: + get: + tags: + - "tapi-path-computation" + 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.RoutingConstraint" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-path-computation" + 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.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/: + get: + tags: + - "tapi-path-computation" + 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.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/service-interface-point/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.context.ServiceInterfacePoint" + description: "none" + parameters: + - in: "body" + name: "tapi.common.context.ServiceInterfacePoint.body-param" + description: "tapi.common.context.ServiceInterfacePoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.context.ServiceInterfacePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/service-interface-point={uuid}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.context.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.context.ServiceInterfacePoint" + schema: + $ref: "#/definitions/tapi.common.context.ServiceInterfacePoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.context.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.context.ServiceInterfacePoint.body-param" + description: "tapi.common.context.ServiceInterfacePoint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.context.ServiceInterfacePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.context.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/available-capacity/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/eth-service-inteface-point-spec/: + get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthServiceIntefacePointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthServiceIntefacePointSpec" + schema: + $ref: "#/definitions/tapi.eth.EthServiceIntefacePointSpec" + 400: + description: "Internal error" + post: + tags: + - "tapi-eth" + summary: "creates tapi.eth.EthServiceIntefacePointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthServiceIntefacePointSpec.body-param" + description: "tapi.eth.EthServiceIntefacePointSpec to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthServiceIntefacePointSpec" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-eth" + summary: "creates or updates tapi.eth.EthServiceIntefacePointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.eth.EthServiceIntefacePointSpec.body-param" + description: "tapi.eth.EthServiceIntefacePointSpec to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.eth.EthServiceIntefacePointSpec" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-eth" + summary: "removes tapi.eth.EthServiceIntefacePointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/name/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/service-interface-point={uuid}/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/total-potential-capacity/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] + responses: + 200: + description: "tapi.topology.TopologyContext" + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-topology" + summary: "creates tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: + - in: "body" + name: "tapi.topology.context.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-topology" + summary: "creates or updates tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: + - in: "body" + name: "tapi.topology.context.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-topology" + summary: "removes tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/topology-context/nw-topology-service/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NetworkTopologyService" + description: "none" + parameters: [] + responses: + 200: + description: "tapi.topology.NetworkTopologyService" + schema: + $ref: "#/definitions/tapi.topology.NetworkTopologyService" + 400: + description: "Internal error" + /data/context/topology-context/nw-topology-service/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.TopologyRef" + description: "none" + parameters: + - name: "topology-uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.topologycontext.Topology" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Topology" + schema: + $ref: "#/definitions/tapi.topology.Topology" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/boundary-node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Link" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Link" + schema: + $ref: "#/definitions/tapi.topology.Link" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.ValidationMechanism" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "validation-mechanism" + in: "path" + description: "Id of validation-mechanism" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.ValidationMechanism" + schema: + $ref: "#/definitions/tapi.topology.ValidationMechanism" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.topology.Node" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.topology.Node" + schema: + $ref: "#/definitions/tapi.topology.topology.Node" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.TopologyRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.node.NodeEdgePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.node.NodeEdgePoint" + schema: + $ref: "#/definitions/tapi.topology.node.NodeEdgePoint" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{aggregated-node-edge-point-node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-cep-layer-protocol={layer-protocol-qualifier}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NepLayerProtocolCapability" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "layer-protocol-qualifier" + in: "path" + description: "Id of available-cep-layer-protocol" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NepLayerProtocolCapability" + schema: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" + schema: + $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ + : get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.ceplist.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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.ceplist.ConnectionEndPoint" + schema: + $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/aggregated-connection-end-point={topology-uuid},{aggregated-connection-end-point-node-uuid},{aggregated-connection-end-point-node-edge-point-uuid},{aggregated-connection-end-point-connection-end-point-uuid}/ + : get: + tags: + - "tapi-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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-connection-end-point" + required: true + type: "string" + - name: "aggregated-connection-end-point-node-uuid" + in: "path" + description: "Id of aggregated-connection-end-point" + required: true + type: "string" + - name: "aggregated-connection-end-point-node-edge-point-uuid" + in: "path" + description: "Id of 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.ConnectionEndPointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/client-node-edge-point={topology-uuid},{client-node-edge-point-node-uuid},{client-node-edge-point-node-edge-point-uuid}/ + : get: + tags: + - "tapi-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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of client-node-edge-point" + required: true + type: "string" + - name: "client-node-edge-point-node-uuid" + in: "path" + description: "Id of client-node-edge-point" + required: true + type: "string" + - name: "client-node-edge-point-node-edge-point-uuid" + in: "path" + description: "Id of client-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthConnectionEndPointSpec" + description: "Augments the base LayerProtocol information in ConnectionEndPoint\ + \ with ETH-specific information" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthConnectionEndPointSpec" + schema: + $ref: "#/definitions/tapi.eth.EthConnectionEndPointSpec" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthCtpPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthCtpPac" + schema: + $ref: "#/definitions/tapi.eth.EthCtpPac" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/eth-ctp-common-pac/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthCtpCommonPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthCtpCommonPac" + schema: + $ref: "#/definitions/tapi.eth.EthCtpCommonPac" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/eth-ctp-common-pac/filter-config/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.ControlFrameFilter" + description: "This attribute models the FilterConfig MI defined in section 8.3/G.8021.\ + \ It indicates the configured filter action for each of the 33 group MAC addresses\ + \ for control frames. The 33 MAC addresses are:\r\n - All bridges\ + \ address: 01-80-C2-00-00-10,\r\n - Reserved addresses: 01-80-C2-00-00-00\ + \ to 01-80-C2-00-00-0F,\r\n - GARP Application addresses: 01-80-C2-00-00-20\ + \ to 01-80-C2-00-00-2F.\r\n The filter action is Pass or Block.\ + \ \r\n If the destination address of the incoming ETH_CI_D\ + \ matches one of the above addresses, the filter process shall perform the\ + \ corresponding configured filter action. \r\n If none of the\ + \ above addresses match, the ETH_CI_D is passed." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.ControlFrameFilter" + schema: + $ref: "#/definitions/tapi.eth.ControlFrameFilter" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/eth-ctp-common-pac/traffic-conditioning-pac/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.TrafficConditioningPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.TrafficConditioningPac" + schema: + $ref: "#/definitions/tapi.eth.TrafficConditioningPac" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/eth-ctp-common-pac/traffic-conditioning-pac/cond-config-list={queue-id}/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.TrafficConditioningConfiguration" + description: "This attribute indicates for the conditioner process the conditioning\ + \ parameters:\r\n - Queue ID: Indicates the Queue ID\r\n \ + \ - Committed Information Rate (CIR): number of bits per second\r\ + \n - Committed Burst Size (CBS): number of bytes\r\n \ + \ - Excess Information Rate (EIR): number of bits per second\r\n\ + \ - Excess Burst Size (EBS): number of bytes\r\n \ + \ - Coupling flag (CF): 0 or 1\r\n - Color mode (CM):\ + \ color-blind and color-aware." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "queue-id" + in: "path" + description: "Id of cond-config-list" + required: true + type: "integer" + format: "int32" + responses: + 200: + description: "tapi.eth.TrafficConditioningConfiguration" + schema: + $ref: "#/definitions/tapi.eth.TrafficConditioningConfiguration" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/eth-ctp-common-pac/traffic-conditioning-pac/prio-config-list={queue-id}/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.PriorityConfiguration" + description: "This attribute indicates the Priority Splitter function for the\ + \ mapping of the Ethernet frame priority (ETH_CI_P) values to the output queue." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "queue-id" + in: "path" + description: "Id of prio-config-list" + required: true + type: "integer" + format: "int32" + responses: + 200: + description: "tapi.eth.PriorityConfiguration" + schema: + $ref: "#/definitions/tapi.eth.PriorityConfiguration" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/eth-ctp-common-pac/traffic-shaping-pac/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.TrafficShapingPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.TrafficShapingPac" + schema: + $ref: "#/definitions/tapi.eth.TrafficShapingPac" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/eth-ctp-common-pac/traffic-shaping-pac/prio-config-list={queue-id}/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.PriorityConfiguration" + description: "This attribute configures the Priority Splitter function for the\ + \ mapping of the Ethernet frame priority (ETH_CI_P) values to the output queue." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "queue-id" + in: "path" + description: "Id of prio-config-list" + required: true + type: "integer" + format: "int32" + responses: + 200: + description: "tapi.eth.PriorityConfiguration" + schema: + $ref: "#/definitions/tapi.eth.PriorityConfiguration" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-ctp/eth-ctp-common-pac/traffic-shaping-pac/queue-config-list={queue-id}/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.QueueConfiguration" + description: "This attribute configures the Queue depth and Dropping threshold\ + \ parameters of the Queue process. The Queue depth sets the maximum size of\ + \ the queue in bytes. An incoming ETH_CI traffic unit is dropped if there\ + \ is insufficient space in the queue to hold the whole unit. The Dropping\ + \ threshold sets the threshold of the queue. If the queue is filled beyond\ + \ this threshold, incoming ETH_CI traffic units accompanied by the ETH_CI_DE\ + \ signal set are dropped." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "queue-id" + in: "path" + description: "Id of queue-config-list" + required: true + type: "integer" + format: "int32" + responses: + 200: + description: "tapi.eth.QueueConfiguration" + schema: + $ref: "#/definitions/tapi.eth.QueueConfiguration" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-term/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthTerminationPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthTerminationPac" + schema: + $ref: "#/definitions/tapi.eth.EthTerminationPac" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-term/eth-termination-common-pac/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EthTerminationCommonPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EthTerminationCommonPac" + schema: + $ref: "#/definitions/tapi.eth.EthTerminationCommonPac" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/eth-term/eth-termination-common-pac/priority-regenerate/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.PriorityMapping" + description: "This attribute models the ETHx/ETH-m _A_Sk_MI_P_Regenerate information\ + \ defined in G.8021." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.PriorityMapping" + schema: + $ref: "#/definitions/tapi.eth.PriorityMapping" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/ety-term/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EtyTerminationPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EtyTerminationPac" + schema: + $ref: "#/definitions/tapi.eth.EtyTerminationPac" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/eth-connection-end-point-spec/ety-term/ety-termination-common-pac/ + : get: + tags: + - "tapi-eth" + summary: "returns tapi.eth.EtyTerminationCommonPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.eth.EtyTerminationCommonPac" + schema: + $ref: "#/definitions/tapi.eth.EtyTerminationCommonPac" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MepMipList" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MepMipList" + schema: + $ref: "#/definitions/tapi.oam.MepMipList" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mep={meg-uuid},{mep-local-id}/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MepRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "meg-uuid" + in: "path" + description: "Id of mep" + required: true + type: "string" + - name: "mep-local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MepRef" + schema: + $ref: "#/definitions/tapi.oam.MepRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mip={meg-uuid},{mip-local-id}/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MipRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "meg-uuid" + in: "path" + description: "Id of mip" + required: true + type: "string" + - name: "mip-local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MipRef" + schema: + $ref: "#/definitions/tapi.oam.MipRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load balancing/Resilience)\ + \ should be considered experimental" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "service-interface-point-uuid" + in: "path" + description: "Id of mapped-service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePointRef" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroup" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroup" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-rule-group-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroupRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.InterRuleGroup" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.InterRuleGroup" + schema: + $ref: "#/definitions/tapi.topology.InterRuleGroup" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + - name: "associated-node-rule-group-node-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + - name: "associated-node-rule-group-node-rule-group-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroupRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Rule" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Rule" + schema: + $ref: "#/definitions/tapi.topology.Rule" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-node-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Rule" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Rule" + schema: + $ref: "#/definitions/tapi.topology.Rule" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /operations/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/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/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/create-oam-job/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.CreateOamJob" + description: "operates on tapi.oam.CreateOamJob" + parameters: + - in: "body" + name: "tapi.oam.createoamjob.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.createoamjob.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.CreateOamJob" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/create-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.CreateOamProfile" + description: "operates on tapi.oam.CreateOamProfile" + parameters: + - in: "body" + name: "tapi.oam.createoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.createoamprofile.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.CreateOamProfile" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/create-oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.CreateOamServicePoint" + description: "operates on tapi.oam.CreateOamServicePoint" + parameters: + - in: "body" + name: "tapi.oam.createoamservicepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.createoamservicepoint.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.CreateOamServicePoint" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/create-oam-service/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.CreateOamService" + description: "operates on tapi.oam.CreateOamService" + parameters: + - in: "body" + name: "tapi.oam.createoamservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.createoamservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.CreateOamService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/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/delete-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.DeleteNotificationSubscriptionService" + description: "operates on tapi.notification.DeleteNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.deletenotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-oam-job/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamJob" + description: "operates on tapi.oam.DeleteOamJob" + parameters: + - in: "body" + name: "tapi.oam.deleteoamjob.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.deleteoamjob.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamProfile" + description: "operates on tapi.oam.DeleteOamProfile" + parameters: + - in: "body" + name: "tapi.oam.deleteoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.deleteoamprofile.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamServicePoint" + description: "operates on tapi.oam.DeleteOamServicePoint" + parameters: + - in: "body" + name: "tapi.oam.deleteoamservicepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.deleteoamservicepoint.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-oam-service/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamService" + description: "operates on tapi.oam.DeleteOamService" + parameters: + - in: "body" + name: "tapi.oam.deleteoamservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.deleteoamservice.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/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/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/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/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/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/get-link-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetLinkDetails" + description: "operates on tapi.topology.GetLinkDetails" + parameters: + - in: "body" + name: "tapi.topology.getlinkdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getlinkdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetLinkDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-meg/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.GetMeg" + description: "operates on tapi.oam.GetMeg" + parameters: + - in: "body" + name: "tapi.oam.getmeg.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getmeg.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetMeg" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-node-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetNodeDetails" + description: "operates on tapi.topology.GetNodeDetails" + parameters: + - in: "body" + name: "tapi.topology.getnodedetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getnodedetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetNodeDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-node-edge-point-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetNodeEdgePointDetails" + description: "operates on tapi.topology.GetNodeEdgePointDetails" + parameters: + - in: "body" + name: "tapi.topology.getnodeedgepointdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetNodeEdgePointDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-list/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationList" + description: "operates on tapi.notification.GetNotificationList" + parameters: + - in: "body" + name: "tapi.notification.getnotificationlist.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.getnotificationlist.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-subscription-service-details/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + description: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + parameters: + - in: "body" + name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-subscription-service-list/: + post: + tags: + - "tapi-notification" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-job-list/: + post: + tags: + - "tapi-oam" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamJobList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-job/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.GetOamJob" + description: "operates on tapi.oam.GetOamJob" + parameters: + - in: "body" + name: "tapi.oam.getoamjob.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getoamjob.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamJob" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-profile-list/: + post: + tags: + - "tapi-oam" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamProfileList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.GetOamProfile" + description: "operates on tapi.oam.GetOamProfile" + parameters: + - in: "body" + name: "tapi.oam.getoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getoamprofile.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamProfile" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-service-list/: + post: + tags: + - "tapi-oam" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamServiceList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.GetOamServicePoint" + description: "operates on tapi.oam.GetOamServicePoint" + parameters: + - in: "body" + name: "tapi.oam.getoamservicepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getoamservicepoint.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamServicePoint" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-service/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.GetOamService" + description: "operates on tapi.oam.GetOamService" + parameters: + - in: "body" + name: "tapi.oam.getoamservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getoamservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-service-interface-point-details/: + post: + tags: + - "tapi-common" + summary: "operates on tapi.common.GetServiceInterfacePointDetails" + description: "operates on tapi.common.GetServiceInterfacePointDetails" + parameters: + - in: "body" + name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.common.GetServiceInterfacePointDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-service-interface-point-list/: + post: + tags: + - "tapi-common" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.common.GetServiceInterfacePointList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-supported-notification-types/: + post: + tags: + - "tapi-notification" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetSupportedNotificationTypes" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-topology-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetTopologyDetails" + description: "operates on tapi.topology.GetTopologyDetails" + parameters: + - in: "body" + name: "tapi.topology.gettopologydetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.gettopologydetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetTopologyDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-topology-list/: + post: + tags: + - "tapi-topology" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetTopologyList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/optimize-p-2-p-path/: + 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/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/update-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.UpdateNotificationSubscriptionService" + description: "operates on tapi.notification.UpdateNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.UpdateNotificationSubscriptionService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-oam-job/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamJob" + description: "operates on tapi.oam.UpdateOamJob" + parameters: + - in: "body" + name: "tapi.oam.updateoamjob.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.updateoamjob.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.UpdateOamJob" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamProfile" + description: "operates on tapi.oam.UpdateOamProfile" + parameters: + - in: "body" + name: "tapi.oam.updateoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.updateoamprofile.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.UpdateOamProfile" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamServicePoint" + description: "operates on tapi.oam.UpdateOamServicePoint" + parameters: + - in: "body" + name: "tapi.oam.updateoamservicepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.updateoamservicepoint.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.UpdateOamServicePoint" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-oam-service/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamService" + description: "operates on tapi.oam.UpdateOamService" + parameters: + - in: "body" + name: "tapi.oam.updateoamservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.updateoamservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.UpdateOamService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-service-interface-point/: + post: + tags: + - "tapi-common" + summary: "operates on tapi.common.UpdateServiceInterfacePoint" + description: "operates on tapi.common.UpdateServiceInterfacePoint" + parameters: + - in: "body" + name: "tapi.common.updateserviceinterfacepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.common.updateserviceinterfacepoint.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" +definitions: + tapi.common.AdminStatePac: + type: "object" + properties: + operational-state: + description: "none" + $ref: "#/definitions/tapi.common.OperationalState" + lifecycle-state: + description: "none" + $ref: "#/definitions/tapi.common.LifecycleState" + administrative-state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + tapi.common.AdministrativeState: + type: "string" + enum: + - "LOCKED" + - "UNLOCKED" + tapi.common.Capacity: + type: "object" + properties: + total-size: + description: "Total capacity of the TopologicalEntity in MB/s. In case of\ + \ bandwidthProfile, this is expected to same as the committedInformationRate." + $ref: "#/definitions/tapi.common.CapacityValue" + tapi.common.CapacityPac: + type: "object" + properties: + available-capacity: + description: "Capacity available to be assigned." + $ref: "#/definitions/tapi.common.Capacity" + total-potential-capacity: + description: "An optimistic view of the capacity of the TopologicalEntity\ + \ assuming that any shared capacity is available to be taken." + $ref: "#/definitions/tapi.common.Capacity" + tapi.common.CapacityUnit: + type: "string" + enum: + - "TB" + - "TBPS" + - "GB" + - "GBPS" + - "MB" + - "MBPS" + - "KB" + - "KBPS" + - "GHz" + - "MHz" + tapi.common.CapacityValue: + type: "object" + properties: + value: + type: "integer" + format: "int32" + description: "none" + unit: + description: "none" + $ref: "#/definitions/tapi.common.CapacityUnit" + tapi.common.Context: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.connectivity.ContextAugmentation4" + - $ref: "#/definitions/tapi.notification.ContextAugmentation1" + - $ref: "#/definitions/tapi.oam.ContextAugmentation3" + - $ref: "#/definitions/tapi.path.computation.ContextAugmentation2" + - $ref: "#/definitions/tapi.topology.ContextAugmentation5" + - type: "object" + properties: + service-interface-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.context.ServiceInterfacePoint" + description: "none" + tapi.common.DirectiveValue: + type: "string" + enum: + - "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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a UUID\ + \ in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.common.LayerProtocolName: + type: "string" + enum: + - "ODU" + - "ETH" + - "DSR" + - "PHOTONIC_MEDIA" + tapi.common.LifecycleState: + type: "string" + enum: + - "PLANNED" + - "POTENTIAL_AVAILABLE" + - "POTENTIAL_BUSY" + - "INSTALLED" + - "PENDING_REMOVAL" + tapi.common.LocalClass: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + local-id: + type: "string" + description: "none" + tapi.common.NameAndValue: + type: "object" + properties: + value-name: + type: "string" + description: "The name of the value. The value need not have a name." + value: + type: "string" + description: "The value" + tapi.common.OperationalState: + type: "string" + enum: + - "DISABLED" + - "ENABLED" + tapi.common.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" + 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.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.TimeInterval: + type: "object" + properties: + period: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.TimePeriod" + tapi.common.TimePeriod: + type: "object" + properties: + value: + type: "integer" + format: "int32" + description: "none" + unit: + description: "none" + $ref: "#/definitions/tapi.common.TimeUnit" + tapi.common.TimeRange: + type: "object" + properties: + end-time: + type: "string" + description: "none" + start-time: + type: "string" + description: "none" + tapi.common.TimeUnit: + type: "string" + enum: + - "YEARS" + - "MONTHS" + - "DAYS" + - "HOURS" + - "MINUTES" + - "SECONDS" + - "MILLISECONDS" + - "MICROSECONDS" + - "NANOSECONDS" + - "PICOSECONDS" + tapi.common.context.ServiceInterfacePoint: + allOf: + - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + - $ref: "#/definitions/tapi.eth.ServiceInterfacePointAugmentation1" + tapi.common.getserviceinterfacepointdetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.common.getserviceinterfacepointdetails.Output: + type: "object" + properties: + sip: + description: "none" + $ref: "#/definitions/tapi.common.getserviceinterfacepointlist.output.Sip" + tapi.common.getserviceinterfacepointlist.Output: + type: "object" + properties: + sip: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.getserviceinterfacepointlist.output.Sip" + tapi.common.getserviceinterfacepointlist.output.Sip: + allOf: + - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + - $ref: "#/definitions/tapi.eth.SipAugmentation1" + tapi.common.updateserviceinterfacepoint.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + tapi.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" + bounding-node: + description: "none" + $ref: "#/definitions/tapi.topology.NodeRef" + 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: + protection-role: + description: "none" + $ref: "#/definitions/tapi.connectivity.ProtectionRole" + 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" + 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:node-edge-point/tapi-connectivity:cep-list/tapi-connectivity:connection-end-point/tapi-connectivity:uuid" + description: "none" + 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.ConnectivityConstraint: + type: "object" + properties: + schedule: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + requested-capacity: + description: "none" + $ref: "#/definitions/tapi.common.Capacity" + diversity-exclusion: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + 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\r\n Class of Service Name." + service-type: + description: "none" + $ref: "#/definitions/tapi.connectivity.ServiceType" + coroute-inclusion: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + tapi.connectivity.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" + direction: + description: "The orientation of defined flow at the EndPoint." + $ref: "#/definitions/tapi.common.PortDirection" + capacity: + description: "none" + $ref: "#/definitions/tapi.common.Capacity" + protecting-connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + description: "The association of the FC to LTPs is made via EndPoints.\r\n \ + \ The EndPoint (EP) object class models the access to the FC function.\ + \ \r\n The traffic forwarding between the associated EPs of the\ + \ FC depends upon the type of FC and may be associated with FcSwitch object\ + \ instances. \r\n In cases where there is resilience the EndPoint\ + \ may convey the resilience role of the access to the FC. \r\n \ + \ It can represent a protected (resilient/reliable) point or a protecting\ + \ (unreliable working or protection) point.\r\n The EP replaces\ + \ the Protection Unit of a traditional protection model. \r\n The\ + \ ForwadingConstruct can be considered as a component and the EndPoint as\ + \ a Port on that component" + tapi.connectivity.ConnectivityServiceEndPointRef: + allOf: + - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + - type: "object" + properties: + connectivity-service-end-point-local-id: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-connectivity:connectivity-context/tapi-connectivity:connectivity-service/tapi-connectivity:end-point/tapi-connectivity:local-id" + description: "none" + tapi.connectivity.ConnectivityServiceRef: + type: "object" + properties: + 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.ContextAugmentation4: + type: "object" + properties: + connectivity-context: + description: "Augments the base TAPI Context with ConnectivityService information" + $ref: "#/definitions/tapi.connectivity.context.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.NodeEdgePointAugmentation1: + type: "object" + properties: + cep-list: + description: "none" + $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.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." + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" + hold-off-time: + type: "integer" + format: "int32" + description: "This attribute indicates the time, in milliseconds, between\ + \ declaration of signal degrade or signal fail, and the initialization of\ + \ the protection switching algorithm." + 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 + selection-control: + description: "Degree of administrative control applied to the switch selection." + $ref: "#/definitions/tapi.connectivity.SelectionControl" + preferred-restoration-layer: + type: "array" + description: "Indicate which layer this resilience parameters package configured\ + \ for." + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + restore-priority: + type: "integer" + format: "int32" + description: "none" + restoration-policy: + description: "none" + $ref: "#/definitions/tapi.topology.RestorationPolicy" + restoration-coordinate-type: + description: " The coordination mechanism between multi-layers." + $ref: "#/definitions/tapi.connectivity.CoordinateType" + is-coordinated-switching-both-ends: + type: "boolean" + description: "Is operating such that switching at both ends of each flow acorss\ + \ the FC is coordinated at both ingress and egress ends." + default: false + fault-condition-determination: + type: "string" + description: "none" + is-frozen: + type: "boolean" + description: "Temporarily prevents any switch action to be taken and, as such,\ + \ freezes the current state. \r\n Until the freeze is cleared,\ + \ additional near-end external commands are rejected and fault condition\ + \ changes and received APS messages are ignored.\r\n All\ + \ administrative controls of any aspect of protection are rejected." + default: false + reversion-mode: + description: "Indcates whether the protection scheme is revertive or non-revertive." + $ref: "#/definitions/tapi.connectivity.ReversionMode" + 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" + description: "The FC Route (FcRoute) object class models the individual routes\ + \ of an FC. \r\n The route of an FC object is represented by a\ + \ list of FCs at a lower level. \r\n Note that depending on the\ + \ service supported by an FC, an the FC can have multiple routes." + 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.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-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.UpdateConnectivityService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.connectivity.updateconnectivityservice.Output" + tapi.connectivity.ceplist.ConnectionEndPoint: + allOf: + - $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" + - $ref: "#/definitions/tapi.eth.ConnectionEndPointAugmentation2" + - $ref: "#/definitions/tapi.oam.ConnectionEndPointAugmentation1" + tapi.connectivity.connectivitycontext.ConnectivityService: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.eth.ConnectivityServiceAugmentation1" + - type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + connection: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "none" + tapi.connectivity.connectivityservice.EndPoint: + allOf: + - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + - $ref: "#/definitions/tapi.eth.EndPointAugmentation1" + tapi.connectivity.context.ConnectivityContext: + allOf: + - type: "object" + properties: + connectivity-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.connectivitycontext.ConnectivityService" + connection: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.Connection" + description: "Augments the base TAPI Context with ConnectivityService information" + tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList: + allOf: + - type: "object" + properties: + connection-end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" + description: "none" + tapi.connectivity.createconnectivityservice.Input: + type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.createconnectivityservice.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.connectivity.createconnectivityservice.output.Service" + tapi.connectivity.createconnectivityservice.output.Service: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.eth.ServiceAugmentation1" + - type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + connection: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "none" + tapi.connectivity.deleteconnectivityservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.getconnectiondetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.getconnectiondetails.Output: + type: "object" + properties: + connection: + description: "none" + $ref: "#/definitions/tapi.connectivity.Connection" + tapi.connectivity.getconnectionendpointdetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.getconnectionendpointdetails.Output: + type: "object" + properties: + connection-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" + tapi.connectivity.getconnectivityservicedetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.getconnectivityservicedetails.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.connectivity.getconnectivityservicedetails.output.Service" + tapi.connectivity.getconnectivityservicedetails.output.Service: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.eth.ServiceAugmentation1" + - type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + connection: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "none" + tapi.connectivity.getconnectivityservicelist.Output: + type: "object" + properties: + service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.getconnectivityservicelist.output.Service" + tapi.connectivity.getconnectivityservicelist.output.Service: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.eth.ServiceAugmentation1" + - type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + connection: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "none" + tapi.connectivity.updateconnectivityservice.Input: + type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.updateconnectivityservice.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.connectivity.updateconnectivityservice.output.Service" + tapi.connectivity.updateconnectivityservice.output.Service: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.eth.ServiceAugmentation1" + - type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + connection: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "none" + tapi.eth.BandwidthReport: + type: "object" + properties: + port-id: + type: "integer" + format: "int32" + description: "This attribute returns the far end port identifier." + source-mac-address: + type: "string" + description: "The sourceMacAddress is the address from the far end." + current-bandwidth: + type: "integer" + format: "int32" + description: "This attribute returns the current bandwidth." + nominal-bandwidth: + type: "integer" + format: "int32" + description: "This attribute returns the configured bandwidth" + tapi.eth.ColourMode: + type: "string" + enum: + - "COLOUR_BLIND" + - "COLOUR_AWARE" + tapi.eth.ConnectionEndPointAugmentation2: + type: "object" + properties: + eth-connection-end-point-spec: + description: "Augments the base LayerProtocol information in ConnectionEndPoint\ + \ with ETH-specific information" + $ref: "#/definitions/tapi.eth.EthConnectionEndPointSpec" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.ConnectivityServiceAugmentation1: + type: "object" + properties: + eth-connectivity-service: + description: "none" + $ref: "#/definitions/tapi.eth.EthConnectivityService" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.ControlFrameFilter: + type: "object" + properties: + c-2-00-00-2-a: + type: "boolean" + description: "Reserved for future standardization." + default: false + c-2-00-00-0-c: + type: "boolean" + description: "Reserved for future standardization." + default: false + c-2-00-00-0-b: + type: "boolean" + description: "Reserved for future standardization." + default: false + c-2-00-00-2-c: + type: "boolean" + description: "Reserved for future standardization." + default: false + c-2-00-00-0-e: + type: "boolean" + description: "This attribute identifies the Individual LAN Scope group address,\ + \ Nearest Bridge group address (LLDP protocol)." + default: false + c-2-00-00-2-b: + type: "boolean" + description: "Reserved for future standardization." + default: false + c-2-00-00-0-d: + type: "boolean" + description: "This attribute identifies the Provider Bridge MVRP address." + default: false + c-2-00-00-2-e: + type: "boolean" + description: "Reserved for future standardization." + default: false + c-2-00-00-2-d: + type: "boolean" + description: "Reserved for future standardization." + default: false + c-2-00-00-0-f: + type: "boolean" + description: "Reserved for future standardization." + default: false + c-2-00-00-2-f: + type: "boolean" + description: "Reserved for future standardization." + default: false + c-2-00-00-10: + type: "boolean" + description: "This attribute identifies the 'All LANs Bridge Management Group\ + \ Address'." + default: false + c-2-00-00-09: + type: "boolean" + description: "Reserved for future standardization." + default: false + c-2-00-00-29: + type: "boolean" + description: "Reserved for future standardization." + default: false + c-2-00-00-07: + type: "boolean" + description: "This attribute identifies the Metro Ethernet Forum E-LMI protocol\ + \ group address." + default: false + c-2-00-00-08: + type: "boolean" + description: "This attribute identifies the Provider Bridge Group address." + default: false + c-2-00-00-27: + type: "boolean" + description: "Reserved for future standardization." + default: false + c-2-00-00-05: + type: "boolean" + description: "Reserved for future standardization." + default: false + c-2-00-00-28: + type: "boolean" + description: "Reserved for future standardization." + default: false + c-2-00-00-06: + type: "boolean" + description: "Reserved for future standardization." + default: false + c-2-00-00-25: + type: "boolean" + description: "Reserved for future standardization." + default: false + c-2-00-00-03: + type: "boolean" + description: "This attribute identifies the Nearest non-TPMR Bridge group\ + \ address (Port Authentication protocol)." + default: false + c-2-00-00-26: + type: "boolean" + description: "Reserved for future standardization." + default: false + c-2-00-00-04: + type: "boolean" + description: "This attribute identifies the IEEE MAC-specific Control Protocols\ + \ group address." + default: false + c-2-00-00-23: + type: "boolean" + description: "Reserved for future standardization." + default: false + c-2-00-00-01: + type: "boolean" + description: "This attribute identifies the IEEE MAC-specific Control Protocols\ + \ group address (PAUSE protocol)." + default: false + c-2-00-00-24: + type: "boolean" + description: "Reserved for future standardization." + default: false + c-2-00-00-02: + type: "boolean" + description: "This attribute identifies the IEEE 802.3 Slow_Protocols_Multicast\ + \ address (LACP/LAMP or Link OAM protocols)." + default: false + c-2-00-00-21: + type: "boolean" + description: "This attribute identifies the Customer Bridge MVRP address." + default: false + c-2-00-00-22: + type: "boolean" + description: "Reserved for future standardization." + default: false + c-2-00-00-00: + type: "boolean" + description: "This attribute identifies the STP/RSTP/MSTP protocol address." + default: false + c-2-00-00-20: + type: "boolean" + description: "This attribute identifies the Customer and Provider Bridge MMRP\ + \ address." + default: false + c-2-00-00-0-a: + type: "boolean" + description: "Reserved for future standardization." + default: false + tapi.eth.CsfConfig: + type: "string" + enum: + - "DISABLED" + - "ENABLED" + - "ENABLED_WITH_RDI_FDI" + - "ENABLED_WITH_RDI_FDI_DCI" + - "ENABLED_WITH_DCI" + tapi.eth.CurrentDataAugmentation1: + type: "object" + properties: + eth-pro-active-1-lm-source-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthProActive1LmSourcePerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.CurrentDataAugmentation10: + type: "object" + properties: + eth-on-demand-lm-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthOnDemandLmPerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.CurrentDataAugmentation11: + type: "object" + properties: + eth-link-trace-result-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthLinkTraceResultData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.CurrentDataAugmentation12: + type: "object" + properties: + eth-pro-active-1-dm-source-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthProActive1DmSourcePerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.CurrentDataAugmentation13: + type: "object" + properties: + eth-test-result-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthTestResultData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.CurrentDataAugmentation14: + type: "object" + properties: + eth-pro-active-dm-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthProActiveDmPerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.CurrentDataAugmentation15: + type: "object" + properties: + eth-pro-active-lm-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthProActiveLmPerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.CurrentDataAugmentation2: + type: "object" + properties: + eth-on-demand-1-lm-source-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthOnDemand1LmSourcePerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.CurrentDataAugmentation3: + type: "object" + properties: + eth-on-demand-1-lm-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthOnDemand1LmPerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.CurrentDataAugmentation4: + type: "object" + properties: + eth-on-demand-dm-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthOnDemandDmPerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.CurrentDataAugmentation5: + type: "object" + properties: + eth-on-demand-1-dm-source-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthOnDemand1DmSourcePerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.CurrentDataAugmentation6: + type: "object" + properties: + eth-on-demand-1-dm-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthOnDemand1DmPerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.CurrentDataAugmentation7: + type: "object" + properties: + eth-pro-active-1-lm-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthProActive1LmPerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.CurrentDataAugmentation8: + type: "object" + properties: + eth-pro-active-1-dm-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthProActive1DmPerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.CurrentDataAugmentation9: + type: "object" + properties: + eth-loopback-result-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthLoopbackResultData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.EndPointAugmentation1: + type: "object" + properties: + eth-connectivity-service-end-point-spec: + description: "none" + $ref: "#/definitions/tapi.eth.EthConnectivityServiceEndPointSpec" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.EthCfmLinkTracePac: + type: "object" + properties: + period: + description: "IEEE P802.1Qcx/D0.3:\r\n The interval between\ + \ LTM transmissions to be used by all MEPs in the Maintenance Association." + $ref: "#/definitions/tapi.eth.OamPeriod" + target-mep-id: + type: "integer" + format: "int32" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ An indication of a destination MEP, the MEPID of a MEP.\r\n \ + \ Alternative to destination MAC address.\r\n \ + \ " + drop-eligibility: + type: "boolean" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ Drop eligible bit value to be used in the VLAN tag, if present\ + \ in the transmitted frame." + default: false + ltm-flags: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ The flags field for the LTMs transmitted by the MEP." + tapi.eth.EthCfmLinkTraceResultData: + type: "object" + properties: + egress-action-field: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ An enumerated value indicating the value returned in the Egress\ + \ Action field.\r\n IEEE P802.1Qcx/D0.3:\r\n \ + \ The value EGRESS-NO-TLV indicates that no Reply Egress TLV was returned\ + \ in the LTM." + receive-order: + type: "integer" + format: "int32" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ type uint32 range '1..4294967295'\r\n An index to\ + \ distinguish among multiple LTRs with the same LTR Transaction Identifier\ + \ field value.\r\n Assigned sequentially from 1, in the order\ + \ that the Linktrace Initiator received the LTRs." + seq-number: + type: "integer" + format: "int32" + description: "IEEE P802.1Qcx/D0.3:\r\n type uint32 range '0..4294967295'\r\ + \n Transaction identifier returned by a previous transmit\ + \ linktrace message command, indicating which LTMs response is going to\ + \ be returned.\r\n MEF 38:\r\n The LTM Transaction\ + \ Identifier to which the LTR entries will be attached." + ingress-port-id: + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ Ingress Port ID.\r\n IEEE P802.1Qcx/D0.3:\r\n \ + \ If the ingressActionField attribute contains the value INGRESS-NO-TLV,\ + \ then the contents of this attribute are meaningless." + $ref: "#/definitions/tapi.eth.LldpPortIdSubtype" + organization-specific-tlv: + type: "string" + description: "String length '0 | 4..1500';\r\n All Organization\ + \ specific TLVs returned in the LTR, if any. Includes all octets including\ + \ and following the TLV Length field of each TLV, concatenated together." + ingress-action-field: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ The value returned in the Ingress Action Field of the LTM.\r\n\ + \ IEEE P802.1Qcx/D0.3:\r\n The value INGRESS-NO-TLV\ + \ indicates that no Reply Ingress TLV was returned in the LTM.\r\n \ + \ " + chassis-id: + description: "MEF 38:\r\n The chassis-id-subtype contains the\ + \ chassis ID entity that is listed in the chassis ID field. This is a combination\ + \ of the 'Chassis ID Subtype' and 'chsssis ID' fields.\r\n \ + \ IEEE P802.1Qcx/D0.3:\r\n The Chassis ID returned in the\ + \ Sender ID TLV of the LTR, if any.\r\n The format of a chassis\ + \ identifier string. Objects of this type are always used with an associated\ + \ lldp-chassis-is-subtype object, which identifies the format of the particular\ + \ lldp-chassis-id object instance.\r\n If the associated\ + \ lldp-chassis-id-subtype object has a value of chassis-component, then\ + \ the octet string identifies a particular instance of the entPhysicalAlias\ + \ object (defined in IETF RFC 2737) for a chassis component (i.e., an entPhysicalClass\ + \ value of chassis(3)).\r\n If the associated lldp-chassis-id-subtype\ + \ object has a value of interface-alias, then the octet string identifies\ + \ a particular instance of the ifAlias object (defined in IETF RFC 2863)\ + \ for an interface on the containing chassis.\r\n If the\ + \ particular ifAlias object does not contain any values, another chassis\ + \ identifier type should be used." + $ref: "#/definitions/tapi.eth.LldpChassisIdSubtype" + forwarded: + type: "boolean" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ Indicates if a LTM was forwarded by the responding MP, as returned\ + \ in the FwdYes flag of the flags field." + default: false + terminal-mep: + type: "boolean" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ A Boolean value stating whether the forwarded LTM reached a MEP\ + \ enclosing its MA, as returned in the Terminal MEP flag of the Flags field." + default: false + ingress-mac: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ MAC address returned in the ingress MAC address field.\r\n \ + \ IEEE P802.1Qcx/D0.3:\r\n If the ingressActionField\ + \ attribute contains the value INGRESS-NO-TLV, then the contents of this\ + \ attribute is meaningless." + egress-port-id: + description: "MEF 38:\r\n IEEE P802.1Qcx/D0.3:\r\n \ + \ Egress Port ID.\r\n IEEE P802.1Qcx/D0.3:\r\n \ + \ If the egressActionField attribute contains the value EGRESS-NO-TLV,\ + \ then the contents of this attribute are meaningless." + $ref: "#/definitions/tapi.eth.LldpPortIdSubtype" + egress-mac: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ MAC address returned in the egress MAC address field.\r\n \ + \ IEEE P802.1Qcx/D0.3:\r\n If the egressActionField\ + \ contains the value EGRESS-NO-TLV, then the contents of this attribute\ + \ are meaningless." + next-egress-identifier: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ String length '8'\r\n An octet field holding the\ + \ Next Egress Identifier returned in the LTR Egress Identifier TLV of the\ + \ LTR.\r\n The Next Egress Identifier Identifies the Linktrace\ + \ Responder that transmitted this LTR, and can forward the LTM to the next\ + \ hop.\r\n This is the same value as the Egress Identifier\ + \ TLV of the forwarded LTM, if any.\r\n If the FwdYes bit\ + \ of the Flags field is false, the contents of this field are undefined,\ + \ i.e., any value can be transmitted, and the field is ignored by the receiver." + last-egress-identifier: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ String length '8'\r\n An octet field holding the\ + \ Last Egress Identifier returned in the LTR Egress Identifier TLV of the\ + \ LTR.\r\n The Last Egress Identifier identifies the MEP\ + \ Linktrace Initiator that originated, or the Linktrace Responder that forwarded,\ + \ the LTM to which this LTR is the response.\r\n This is\ + \ the same value as the Egress Identifier TLV of that LTM." + relay-action-field: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ An enumerated value indicating the value returned in the Relay\ + \ Action field.\r\n " + reply-ttl: + type: "integer" + format: "int32" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ TTL field value for a returned LTR.\r\n Range '0..255'" + tapi.eth.EthCfmMaintenanceAssociation: + type: "object" + properties: + maintenance-association-name: + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ The Maintenance Association name and name format choice." + $ref: "#/definitions/tapi.eth.MaintenanceAssociationName" + id-permission: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ This parameter indicates what, if anything, is to be included in\ + \ the Sender ID TLV transmitted by Maintenance Points configured in this\ + \ MA.\r\n A value of 'defer' means that the contents of the\ + \ Sender ID TLV are determined by the enclosing Maintenance Domain instance." + tapi.eth.EthCfmMaintenanceDomain: + type: "object" + properties: + maintenance-domain-name: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ A reference to the maintenance domain that this maintenance group\ + \ is associated with." + maintenance-domain-name-type: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ The Maintenance Domain name format choice." + tapi.eth.EthConnectionEndPointSpec: + type: "object" + properties: + eth-term: + description: "none" + $ref: "#/definitions/tapi.eth.EthTerminationPac" + ety-term: + description: "none" + $ref: "#/definitions/tapi.eth.EtyTerminationPac" + eth-ctp: + description: "none" + $ref: "#/definitions/tapi.eth.EthCtpPac" + tapi.eth.EthConnectivityService: + type: "object" + tapi.eth.EthConnectivityServiceEndPointSpec: + type: "object" + properties: + eth-ctp-common-pac: + description: "none" + $ref: "#/definitions/tapi.eth.EthCtpCommonPac" + eth-termination-common-pac: + description: "none" + $ref: "#/definitions/tapi.eth.EthTerminationCommonPac" + ety-termination-common-pac: + description: "none" + $ref: "#/definitions/tapi.eth.EtyTerminationCommonPac" + tapi.eth.EthCtpCommonPac: + type: "object" + properties: + vlan-config: + type: "integer" + format: "int32" + description: "This attribute models the ETHx/ETH-m_A_So_MI_Vlan_Config information\ + \ defined in G.8021.\r\n range of type : -1, 0, 1..4094" + csf-rdi-fdi-enable: + type: "boolean" + description: "This attribute models the MI_CSFrdifdiEnable information defined\ + \ in G.8021." + default: false + filter-config: + description: "This attribute models the FilterConfig MI defined in section\ + \ 8.3/G.8021. It indicates the configured filter action for each of the\ + \ 33 group MAC addresses for control frames. The 33 MAC addresses are:\r\ + \n - All bridges address: 01-80-C2-00-00-10,\r\n \ + \ - Reserved addresses: 01-80-C2-00-00-00 to 01-80-C2-00-00-0F,\r\ + \n - GARP Application addresses: 01-80-C2-00-00-20 to 01-80-C2-00-00-2F.\r\ + \n The filter action is Pass or Block. \r\n \ + \ If the destination address of the incoming ETH_CI_D matches one of the\ + \ above addresses, the filter process shall perform the corresponding configured\ + \ filter action. \r\n If none of the above addresses match,\ + \ the ETH_CI_D is passed." + $ref: "#/definitions/tapi.eth.ControlFrameFilter" + traffic-shaping-pac: + description: "none" + $ref: "#/definitions/tapi.eth.TrafficShapingPac" + mac-length: + type: "integer" + format: "int32" + description: "This attribute models the MAC_Lenght MI defined in 8.6/G.8021\ + \ for the MAC Length Check process. It indicates the allowed maximum frame\ + \ length in bytes.\r\n range of type : 1518, 1522, 2000" + default: 2000 + csf-report: + type: "boolean" + description: "This attribute models the MI_CSF_Reported information defined\ + \ in G.8021.\r\n range of type : true, false" + default: false + filter-config-snk: + type: "array" + description: "This attribute models the FilteConfig MI defined in 8.3/G.8021.\ + \ It indicates the configured filter action for each of the 33 group MAC\ + \ addresses for control frames. The 33 MAC addresses are:\r\n \ + \ 01-80-C2-00-00-10, \r\n 01-80-C2-00-00-00 to 01-80-C2-00-00-0F,\ + \ and \r\n 01-80-C2-00-00-20 to 01-80-C2-00-00-2F.\r\n \ + \ The filter action is Pass or Block. \r\n If\ + \ the destination address of the incoming ETH_CI_D matches one of the above\ + \ addresses, the filter process shall perform the corresponding configured\ + \ filter action. \r\n If none of the above addresses match,\ + \ the ETH_CI_D is passed." + items: + type: "string" + pll-thr: + type: "integer" + format: "int32" + description: "This attribute provisions the threshold for the number of active\ + \ ports. If the number of active ports is more than zero but less than the\ + \ provisioned threshold, a cPLL (Partial Link Loss) is raised. See section\ + \ 9.7.1.2 of G.8021.\r\n range of type : 0..number of ports" + csf-config: + description: "This attribute models the combination of all CSF related MI\ + \ signals (MI_CSF_Enable, MI_CSFrdifdi_Enable, MI_CSFdci_Enable) as defined\ + \ in G.8021.\r\n range of type : true, false" + $ref: "#/definitions/tapi.eth.CsfConfig" + is-ssf-reported: + type: "boolean" + description: "This attribute provisions whether the SSF defect should be reported\ + \ as fault cause or not.\r\n It models the ETH-LAG_FT_Sk_MI_SSF_Reported\ + \ defined in G.8021." + default: false + collector-max-delay: + type: "integer" + format: "int32" + description: "See 802.1AX:\r\n The value of this attribute\ + \ defines the maximum delay, in tens of microseconds, that may be imposed\ + \ by the Frame Collector between receiving a frame from an Aggregator Parser,\ + \ and either delivering the frame to its MAC Client or discarding the frame\ + \ (see IEEE 802.1AX clause 5.2.3.1.1).\r\n range of type\ + \ : 16-bit" + auxiliary-function-position-sequence: + type: "array" + description: "This attribute indicates the positions (i.e., the relative order)\ + \ of all the MEP, MIP, and TCS objects which are associated with the CTP." + items: + type: "integer" + format: "int32" + traffic-conditioning-pac: + description: "none" + $ref: "#/definitions/tapi.eth.TrafficConditioningPac" + tapi.eth.EthCtpPac: + type: "object" + properties: + eth-ctp-common-pac: + description: "none" + $ref: "#/definitions/tapi.eth.EthCtpCommonPac" + partner-system-priority: + type: "integer" + format: "int32" + description: "See 802.1AX:\r\n Indicates the priority associated\ + \ with the Partners System ID. If the aggregation is manually configured,\ + \ this System Priority value will be a value assigned by the local System.\r\ + \n range of type : 2-octet" + partner-oper-key: + type: "integer" + format: "int32" + description: "See 802.1AX:\r\n The current operational value\ + \ of the Key for the Aggregators current protocol Partner. If the aggregation\ + \ is manually configured, this Key value will be a value assigned by the\ + \ local System.\r\n range of type : 16-bit" + actor-system-priority: + type: "integer" + format: "int32" + description: "See 802.1AX:\r\n Indicating the priority associated\ + \ with the Actors System ID.\r\n range of type : 2-octet" + actor-oper-key: + type: "integer" + format: "int32" + description: "See 802.1AX:\r\n The current operational value\ + \ of the Key for the Aggregator. The administrative Key value may differ\ + \ from the operational Key value for the reasons discussed in 5.6.2.\r\n\ + \ The meaning of particular Key values is of local significance.\r\ + \n range of type : 16 bit" + data-rate: + type: "integer" + format: "int32" + description: "See 802.1AX:\r\n The current data rate, in bits\ + \ per second, of the aggregate link. The value is calculated as N times\ + \ the data rate of a single link in the aggregation, where N is the number\ + \ of active links." + actor-system-id: + type: "string" + description: "See 802.1AX:\r\n A MAC address used as a unique\ + \ identifier for the System that contains this Aggregator." + partner-system-id: + type: "string" + description: "See 802.1AX:\r\n A MAC address consisting of\ + \ the unique identifier for the current protocol Partner of this Aggregator.\ + \ A value of zero indicates that there is no known Partner. If the aggregation\ + \ is manually configured, this System ID value will be a value assigned\ + \ by the local System." + tapi.eth.EthLinkTraceJob: + type: "object" + properties: + time-to-live: + type: "integer" + format: "int32" + description: "G.8052: This parameter provides the Time To Live (TTL) parameter\ + \ of the Link Track protocol.\r\n The TTL parameter allows\ + \ the receiver (MIP or MEP) of the LTM frame to determine if the frame can\ + \ be terminated. TTL is decremented every time the LTM frame is relayed.\ + \ LTM frame with TTL<=1 is terminated and not relayed.\r\n \ + \ IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n An\ + \ initial value for the LTM TTL field." + eth-cfm-link-trace-pac: + description: "none" + $ref: "#/definitions/tapi.eth.EthCfmLinkTracePac" + destination-address: + type: "string" + description: "G.8052: This parameter provides the destination address, i.e.,\ + \ the MAC Address of the target MEP or MIP." + priority: + type: "integer" + format: "int32" + description: "G.8052: This parameter provides the priority to be used in the\ + \ LBM frame.\r\n G.8052: This parameter provides the priority\ + \ to be used in the TST frame." + default: 7 + tapi.eth.EthLinkTraceResultData: + type: "object" + properties: + result-list: + type: "array" + description: "G.8052: This parameter returns the results of the LT process.\ + \ It contains a list of the result received from the individual LTR frames.\r\ + \n The result from the individual LTR frame include the Source\ + \ Mac Address, the TTL, and TLV." + items: + $ref: "#/definitions/tapi.eth.LinkTraceResult" + eth-cfm-link-trace-result-data: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.eth.EthCfmLinkTraceResultData" + tapi.eth.EthLoopbackJob: + type: "object" + properties: + number: + type: "integer" + format: "int32" + description: "G.8052: This parameter specifies how many LB messages to be\ + \ sent for the LB_Series process." + eth-oam-test-loopback-common-pac: + description: "none" + $ref: "#/definitions/tapi.eth.EthOamTestLoopbackCommonPac" + lbm-data-tlv: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n String length '1..1480'\r\ + \n The loopback message Data TLV type.\r\n \ + \ MEF 38:\r\n An arbitrary amount of data to be included\ + \ in a Data TLV." + tapi.eth.EthLoopbackResultData: + type: "object" + properties: + ber-lbr-frames: + type: "integer" + format: "int32" + description: "G.8052: This parameter returns the number of LBR frames where\ + \ there was a bit error in the pattern." + crc-lbr-frames: + type: "integer" + format: "int32" + description: "G.8052: This parameter returns the number of LBR frames where\ + \ the CRC in the pattern failed." + detected-peer-mep: + type: "array" + description: "G.8052: This parameter returns the MAC addresses of the discovered\ + \ peer MEPs of the subject MEP." + items: + type: "string" + sent-lbm-frames: + type: "integer" + format: "int32" + description: "G.8052: This parameter returns the total number of sent LBM\ + \ frames." + out-of-order-lbr-frames: + type: "integer" + format: "int32" + description: "G.8052: This parameter returns the number of LBR traffic unites\ + \ (messages) that were received out of order (OO)." + rec-lbr-frames: + type: "integer" + format: "int32" + description: "G.8052: This parameter returns the total number of received\ + \ LBR messages, including the out of order LBR frames." + tapi.eth.EthMeasurementJobControlCommon: + type: "object" + properties: + flr-availability-delta-time: + type: "integer" + format: "int32" + description: "Time length over which each Availability Frame Loss Ratio value\ + \ is calculated.\r\n MEF 35.1:\r\n [R78]/[CR58]\ + \ [O8] A SOAM PM Implementation MUST support a configurable parameter for\ + \ the length of time over which each Availability flr value is calculated,\ + \ with a range of 1s – 300s. This parameter is equivalent to delta-t as\ + \ specified by MEF 10.3.\r\n [R79]/[CR59] [O8] The length\ + \ of time over which each Availability flr value is calculated (delta-t)\ + \ MUST be an integer multiple of the interval between each SLM/1SL frame\ + \ transmission.\r\n [D31]/[CD16] [O8] The default length\ + \ of time over which each Availability flr value is calculated SHOULD be\ + \ 1s." + default: 1 + time-of-the-day-alignment: + type: "boolean" + description: "MEF 35.1:\r\n [D7] A SOAM PM Implementation SHOULD\ + \ allow for no alignment to the time-of-day clock." + default: true + test-identifier: + type: "integer" + format: "int32" + description: "This attribute is used to distinguish each measurement session\ + \ if multiple measurement sessions are simultaneously activated towards\ + \ a peer MEP including concurrent on-demand and proactive tests.\r\n \ + \ It must be unique at least within the context of any measurement\ + \ type for the MEG and initiating MEP.\r\n Note: The attribute\ + \ is not used in case of 2-way loss measurement.\r\n range\ + \ of type : 0..(2^32) - 1" + repetition-period: + description: "This attribute contains the time between the start of two measurement\ + \ intervals. This IS applicable for the repetitive instance type and MAY\ + \ be applicable for the repetitive series type. \r\n Note\ + \ that a value of 0 means not applicable (NA), which is for the cases of\ + \ single instance, single series, or repetitive series without extra gap\ + \ in between the measurement intervals (i.e., also as known as continuous\ + \ series)." + $ref: "#/definitions/tapi.eth.RepetitionPeriod" + offset-from-time-of-the-day: + type: "integer" + format: "int32" + description: "MEF 35.1:\r\n [D8] A SOAM PM Implementation SHOULD\ + \ support a configurable (in minutes) offset from ToD time for alignment\ + \ of the start of Measurement Intervals other than the first Measurement\ + \ Interval." + flr-availability-threshold: + type: "string" + description: "Frame loss ratio threshold to be used in evaluating the Available/Unavailable\ + \ state of each time interval (as specified by Availability Delta Time).\r\ + \n MEF 35.1:\r\n [R81]/[CR61] A SOAM PM Implementation\ + \ MUST support a configurable Availability frame loss ratio threshold to\ + \ be used in evaluating the Available/Unavailable state of each delta-t\ + \ interval per MEF 10.3\r\n [R82]/[CR62] The Availability\ + \ frame loss ratio threshold range of 0.00 through 1.00 MUST be supported\ + \ in increments of 0.01.\r\n [D33]/[CD18] [O8] The default\ + \ Availability frame loss ratio threshold SHOULD be 0.1." + default: "0.1" + priority: + type: "integer" + format: "int32" + description: "This attribute contains the priority value on which the MEP\ + \ performs the measurement.\r\n When the measurement is enabled,\ + \ the MEP should use this value to encode the priority of generated measurement\ + \ frames (OAM PDU frames.).\r\n The EMF usese this value\ + \ to assign the P parameter of the measurement operation." + default: 7 + flr-availability-samples: + type: "integer" + format: "int32" + description: "Number of consecutive Availability Frame Loss Ratio measurements\ + \ to be used to determine Available/Unavailable state transitions.\r\n \ + \ MEF 35.1:\r\n [R80]/[CR60] [O8] The number\ + \ range of 1 through 10 MUST be supported for the configurable number of\ + \ consecutive Availability flr measurements to be used to determine Available/Unavailable\ + \ state transitions.\r\n This parameter is equivalent to\ + \ the Availability parameter of n as specified by MEF 10.3.\r\n \ + \ [D32]/[CD17] [O8] The default number of n for Availability SHOULD\ + \ be 10." + default: 10 + message-period: + type: "integer" + format: "int32" + description: "This attribute indicates the period (frequency) of the measurement\ + \ frame transmission.\r\n Note that the value 0 means that\ + \ only one OAM message per measurement interval is generated.\r\n \ + \ Unit is milliseconds.\r\n range of type : 100ms,\ + \ 1s, 10s" + default: 1000 + measurement-interval: + type: "integer" + format: "int32" + description: "This attribute contains the discrete non overlapping periods\ + \ of time (in seconds) during which measurements are performed\r\n \ + \ (i.e., OAM messages are generated) and reports are gathered\ + \ at the end of the measurement intervals.\r\n Note that\ + \ the value 0 means a degenerated measurement interval with a single OAM\ + \ message and the report is sent as immediately as possible." + tapi.eth.EthMegCommon: + type: "object" + properties: + meg-identifier: + type: "string" + description: "Optional in case 802.1Q maintenanceAssociationName is used." + meg-level: + type: "integer" + format: "int32" + description: "none" + cc-period: + description: "This attribute models the MI_CC_Period signal defined in G.8021\ + \ and configured as specified in G8051. \r\n It is the period\ + \ at which the CCM message should be sent. \r\n Default values\ + \ are: 3.33 ms for PS, 100 ms for PM, 1 s for FM.\r\n ITU-T\ + \ G.8013/Y.1731 (2015)/Amd.1 (11/2018): The ETH-CC transmission period is\ + \ the same for all MEPs in the MEG." + $ref: "#/definitions/tapi.eth.OamPeriod" + client-mel: + type: "integer" + format: "int32" + description: "none" + is-cc-enabled: + type: "boolean" + description: "This attribute models the MI_CC_Enable signal defined in G.8021\ + \ and configured as specified in G8051.\r\n ITU-T G.8013/Y.1731\ + \ (2015)/Amd.1 (11/2018): When ETH-CC transmission is enabled in a MEG,\r\ + \n all MEPs are enabled to periodically transmit frames with\ + \ ETH-CC information to their peer MEPs in the MEG." + default: false + tapi.eth.EthMegSpec: + type: "object" + properties: + eth-cfm-maintenance-association: + description: "none" + $ref: "#/definitions/tapi.eth.EthCfmMaintenanceAssociation" + eth-meg-common: + description: "none" + $ref: "#/definitions/tapi.eth.EthMegCommon" + eth-cfm-maintenance-domain: + description: "none" + $ref: "#/definitions/tapi.eth.EthCfmMaintenanceDomain" + tapi.eth.EthMepCommon: + type: "object" + properties: + codirectional: + type: "boolean" + description: "This attribute specifies the directionality of the Ethernet\ + \ MEP with respect to the associated CEP. The value of TRUE means that the\ + \ sink part of the MEP terminates the same signal direction as the sink\ + \ part of the CEP. The Source part behaves similarly. This attribute is\ + \ meaningful only when CEP is bidirectional." + default: true + lck-priority: + type: "integer" + format: "int32" + description: "This attribute models the MI_LCK_Pri signal defined in G.8021\ + \ and configured as specified in G8051. It is the priority at which the\ + \ LCK messages should be sent." + default: 7 + mep-identifier: + type: "integer" + format: "int32" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ Integer that is unique among all the MEPs in the same Maintenance\ + \ Association (MEG).\r\n G.8052:\r\n This\ + \ attribute contains the identifier of the MEP." + lck-period: + description: "This attribute models the MI_LCK_Period signal defined in G.8021\ + \ and configured as specified in G8051. It is the frequency at which the\ + \ LCK messages should be sent.\r\n range of type : 1s, 1min" + $ref: "#/definitions/tapi.eth.OamPeriod" + cc-priority: + type: "integer" + format: "int32" + description: "This attribute models the MI_CC_Pri signal defined in G.8021\ + \ and configured as specified in G8051. It is the priority at which the\ + \ CCM message should be sent." + default: 7 + tapi.eth.EthMepSink: + type: "object" + properties: + peer-mep-identifier: + type: "array" + description: "G.8052:\r\n This attribute models the MI_PeerMEP_ID[i]\ + \ signal defined in G.8021 and configured as specified in G.8051. It provides\ + \ the identifiers of the MEPs which are peer to the subject MEP." + items: + type: "integer" + format: "int32" + lm-m: + type: "integer" + format: "int32" + description: "This attribute defines the number of consecutive good seconds\ + \ necessary for the clearing of 'degraded'. See also section 'Degraded signal\ + \ defect (dDEG)' in G.8021." + default: 10 + is-csf-reported: + type: "boolean" + description: "This attribute models the MI_CSF_Reported signal defined in\ + \ G.8021 and configured as specified in G8051. It configures whether the\ + \ secondary failure CSF should be reported or not." + default: true + lm-deg-thr: + type: "integer" + format: "int32" + description: "This attribute defines the threshold for declaring a 'bad second'.\ + \ See also section 'Degraded signal defect (dDEG)' in G.8021." + default: 30 + bandwidth-report: + description: "This attribute models the content of the bandwidth report received\ + \ by the MEP Sink from the peer MEP Source." + $ref: "#/definitions/tapi.eth.BandwidthReport" + lm-degm: + type: "integer" + format: "int32" + description: "This attribute defines the number of consecutive bad seconds\ + \ necessary for the 'degraded' detection. See also section 'Degraded signal\ + \ defect (dDEG)' in G.8021." + default: 10 + is-csf-rdi-fdi-enabled: + type: "boolean" + description: "This attribute models the MI_CSFrdifdiEnable signal defined\ + \ in G.8021 and configured as specified in G8051.\r\n aSSFrdi\ + \ ? dCSF-RDI and MI_CSFrdifdiEnable\r\n aSSFfdi ? dCSF-FDI\ + \ and MI_CSFrdifdiEnable" + default: true + ais-period: + description: "This attribute models the MI_AIS_Period signal defined in G.8021\ + \ and configured as specified in G8051. It is the frequency at which the\ + \ AIS messages should be sent.\r\n range of type : 1s, 1min" + $ref: "#/definitions/tapi.eth.OamPeriod" + ais-priority: + type: "integer" + format: "int32" + description: "This attribute models the MI_AIS_Pri signal defined in G.8021\ + \ and configured as specified in G8051. It is the priority at which the\ + \ AIS messages should be sent." + default: 7 + unexpected-ltr-received: + type: "integer" + format: "int32" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ The total number of unexpected LTRs received." + lm-tf-min: + type: "integer" + format: "int32" + description: "This attribute defines the necessary number of transmitted frames\ + \ to enable the detection of 'bad seconds'. See also section 'Degraded signal\ + \ defect (dDEG)' in G.8021." + tapi.eth.EthMepSource: + type: "object" + properties: + csf-period: + description: "This attribute models the MI_CSF_Period signal defined in G.8021\ + \ and configured as specified in G8051. It is the period at which the CSF\ + \ messages should be sent.\r\n range of type : 1s, 1min" + $ref: "#/definitions/tapi.eth.OamPeriod" + csf-priority: + type: "integer" + format: "int32" + description: "This attribute models the MI_CSF_Pri signal defined in G.8021\ + \ and configured as specified in G8051. It is the priority at which the\ + \ CSF messages should be sent" + default: 7 + csf-config: + description: "This attribute models the combination of all CSF related MI\ + \ signals (MI_CSF_Enable, MI_CSFrdifdi_Enable, MI_CSFdci_Enable) as defined\ + \ in G.8021." + $ref: "#/definitions/tapi.eth.CsfConfig" + aps-priority: + type: "integer" + format: "int32" + description: "This attribute specifies the priority of the APS messages.\r\ + \n See section 8.1.5 APS insert process in G.8021." + default: 7 + tapi.eth.EthMepSpec: + type: "object" + properties: + eth-mep-common: + description: "none" + $ref: "#/definitions/tapi.eth.EthMepCommon" + mep-mac: + type: "string" + description: "This attribute contains the MAC Address of the MEP." + eth-mep-source: + description: "none" + $ref: "#/definitions/tapi.eth.EthMepSource" + eth-mep-sink: + description: "none" + $ref: "#/definitions/tapi.eth.EthMepSink" + tapi.eth.EthMipCommon: + type: "object" + properties: + is-full-mip: + type: "boolean" + description: "This attribute indicates whether the MIP is a full MIP (true)\ + \ or a down-half MIP (false). Up-half MIP is not foreseen by G.8052" + default: false + tapi.eth.EthMipSpec: + type: "object" + properties: + eth-mip-common: + description: "none" + $ref: "#/definitions/tapi.eth.EthMipCommon" + mip-mac: + type: "string" + description: "This attribute contains the MAC address of the MIP instance." + tapi.eth.EthOamMepServicePoint: + type: "object" + properties: + eth-mep-common: + description: "none" + $ref: "#/definitions/tapi.eth.EthMepCommon" + eth-mep-source: + description: "none" + $ref: "#/definitions/tapi.eth.EthMepSource" + eth-mep-sink: + description: "none" + $ref: "#/definitions/tapi.eth.EthMepSink" + tapi.eth.EthOamMipServicePoint: + type: "object" + properties: + eth-mip-common: + description: "none" + $ref: "#/definitions/tapi.eth.EthMipCommon" + tapi.eth.EthOamService: + type: "object" + properties: + eth-cfm-maintenance-association: + description: "none" + $ref: "#/definitions/tapi.eth.EthCfmMaintenanceAssociation" + eth-meg-common: + description: "none" + $ref: "#/definitions/tapi.eth.EthMegCommon" + eth-cfm-maintenance-domain: + description: "none" + $ref: "#/definitions/tapi.eth.EthCfmMaintenanceDomain" + tapi.eth.EthOamTestLoopbackCommonPac: + type: "object" + properties: + data-tlv-length: + type: "integer" + format: "int32" + description: "G.8052: This parameter provides the length (in number of octet)\ + \ of the optional Data TLV to be included in the TST frame." + period: + description: "G.8052: This parameter provides the periodicity of the TST OAM\ + \ messages.\r\n G.8052: This parameter provides the periodicity\ + \ of the LBM OAM messages used in the LB Series process." + $ref: "#/definitions/tapi.eth.OamPeriod" + drop-eligibility: + type: "boolean" + description: "G.8052: This parameter provides the eligibility of frames with\ + \ unicast ETH-TST information to be discarded when congestion conditions\ + \ are encountered.\r\n G.8052: This parameter provides the\ + \ eligibility of frames with unicast ETH-LB information to be discarded\ + \ when congestion conditions are encountered." + default: false + tapi.eth.EthOnDemand1DmPerformanceData: + type: "object" + properties: + samples-near-end-1-dm-parameters: + description: "This attribute contains the results of an on-demand frame delay\ + \ measurement job in the ingress direction." + $ref: "#/definitions/tapi.eth.SamplesDmPerformanceParameters" + statistical-near-end-1-dm-parameters: + description: "This attribute contains the statistical near end performnace\ + \ parameters." + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + tapi.eth.EthOnDemand1DmSourcePerformanceData: + type: "object" + tapi.eth.EthOnDemand1LmPerformanceData: + type: "object" + properties: + statistical-near-end-1-lm-parameters: + description: "This attribute contains the statistical near end performnace\ + \ parameters." + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + total-counters-near-end-1-lm-parameters: + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the ingress direction." + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" + tapi.eth.EthOnDemand1LmSourcePerformanceData: + type: "object" + tapi.eth.EthOnDemandDmPerformanceData: + type: "object" + properties: + statistical-bi-dir-dm-parameters: + description: "This attribute contains the statistical bidirectional performnace\ + \ parameters." + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + samples-far-end-dm-parameters: + description: "This attribute contains the results of an on-demand frame delay\ + \ measurement job in the ingress direction." + $ref: "#/definitions/tapi.eth.SamplesDmPerformanceParameters" + statistical-far-end-dm-parameters: + description: "This attribute contains the statistical far end performnace\ + \ parameters." + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + statistical-near-end-dm-parameters: + description: "This attribute contains the statistical near end performnace\ + \ parameters." + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + samples-near-end-dm-parameters: + description: "This attribute contains the results of an on-demand frame delay\ + \ measurement job in the ingress direction." + $ref: "#/definitions/tapi.eth.SamplesDmPerformanceParameters" + tapi.eth.EthOnDemandDualEndedMeasurementJob: + type: "object" + properties: + eth-on-demand-measurement-job-control-sink: + description: "none" + $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSink" + eth-on-demand-measurement-job-control-source: + description: "none" + $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" + tapi.eth.EthOnDemandLmPerformanceData: + type: "object" + properties: + bidir-unavailable-intervals: + type: "integer" + format: "int32" + description: "A generalized (bidirectional) UAS.\r\n MEF 35.1:\ + \ A 32-bit counter reflecting the number of delta-t intervals evaluated\ + \ as Unavailable (i.e., for which A(delta-t) = 0).\r\ + \n " + statistical-far-end-lm-parameters: + description: "This attribute contains the statistical far end performnace\ + \ parameters." + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + statistical-near-end-lm-parameters: + description: "This attribute contains the statistical near end performnace\ + \ parameters." + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + total-counters-near-end-lm-parameters: + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the ingress direction." + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" + total-counters-far-end-lm-parameters: + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the egress direction." + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" + tapi.eth.EthOnDemandMeasurementJobControlSink: + allOf: + - $ref: "#/definitions/tapi.eth.EthMeasurementJobControlCommon" + - type: "object" + properties: + sink-mep-id: + type: "integer" + format: "int32" + description: "none" + source-address: + type: "string" + description: "This attribute contains the MAC address of the peer MEP. See\ + \ G.8013 for details." + description: "This object class represents an on-demand measurement job controller\ + \ sink for 1-way measurements. It is created as a result of an establishOnDemandDualEndedMeasurementJobSink()\ + \ operation. It is deleted either automatically after the measurement job\ + \ has completed (stop time reached) and the performance data AVC notification\ + \ has been sent, or by an explicit abortOnDemandMeasurementJob() operation\ + \ when the measurement job is running." + tapi.eth.EthOnDemandMeasurementJobControlSource: + allOf: + - $ref: "#/definitions/tapi.eth.EthMeasurementJobControlCommon" + - type: "object" + properties: + data-tlv-length: + type: "integer" + format: "int32" + description: "This parameter provides the size of the optional data TLV.\r\ + \n Non-negative integer represents the number of bytes\ + \ for the length of the padding TLV.\r\n Notes:\r\n \ + \ When configuring this parameter one should be aware of the\ + \ maximum allowed total frame size limitation.\r\n The\ + \ attribute is not used in case of 2-way loss measurement.\r\n \ + \ range of type : Depends on the allowed MTU size." + destination-address: + type: "string" + description: "This attribute contains the MAC address of the peer MEP. See\ + \ G.8013 for details." + oam-pdu-generation-type: + description: "This attribute contains the pattern that is used for the generation\ + \ of OAM PDUs." + $ref: "#/definitions/tapi.eth.OamPduGenerationType" + controller-mep-id: + type: "integer" + format: "int32" + description: "none" + description: "Basic attributes: destinationAddress, priority\r\n \ + \ Measurement configuration related attributes: oamPduGenerationType, startTime,\ + \ stopTime, messagePeriod, repetitionPeriod, measurementInterval\r\n \ + \ Optional attributes: dataTlvLength, testIdentifier\r\n \ + \ This object class represents an on-demand measurement job controller source\ + \ for 1-way measurements. It is created as a result of an establishOnDemandDualEndedMeasurementJobSource()\ + \ operation. It is deleted either automatically after the measurement job\ + \ has completed (stop time reached), or by an explicit abortOnDemandMeasurementJob()\ + \ operation while the measurement job is running." + tapi.eth.EthOnDemandSingleEndedMeasurementJob: + type: "object" + properties: + eth-on-demand-measurement-job-control-source: + description: "none" + $ref: "#/definitions/tapi.eth.EthOnDemandMeasurementJobControlSource" + tapi.eth.EthProActive1DmPerformanceData: + type: "object" + properties: + statistical-near-end-1-dm-parameters: + description: "This attribute contains the statistical near end performnace\ + \ parameters." + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + tapi.eth.EthProActive1DmSourcePerformanceData: + type: "object" + tapi.eth.EthProActive1LmPerformanceData: + type: "object" + properties: + statistical-near-end-1-lm-parameters: + description: "This attribute contains the statistical near end performnace\ + \ parameters." + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + total-counters-near-end-1-lm-parameters: + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the ingress direction." + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" + tapi.eth.EthProActive1LmSourcePerformanceData: + type: "object" + tapi.eth.EthProActiveDmPerformanceData: + type: "object" + properties: + statistical-bi-dir-dm-parameters: + description: "This attribute contains the statistical bidirectional performnace\ + \ parameters." + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + statistical-far-end-dm-parameters: + description: "This attribute contains the statistical far end performnace\ + \ parameters." + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + statistical-near-end-dm-parameters: + description: "This attribute contains the statistical near end performnace\ + \ parameters." + $ref: "#/definitions/tapi.eth.StatisticalDmPerformanceParameters" + tapi.eth.EthProActiveDualEndedMeasurementJob: + type: "object" + properties: + eth-pro-active-measurement-job-control-source: + description: "none" + $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" + eth-pro-active-measurement-job-control-sink: + description: "none" + $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSink" + tapi.eth.EthProActiveLmPerformanceData: + type: "object" + properties: + bidir-unavailable-intervals: + type: "integer" + format: "int32" + description: "A generalized (bidirectional) UAS.\r\n MEF 35.1:\ + \ A 32-bit counter reflecting the number of delta-t intervals evaluated\ + \ as Unavailable (i.e., for which A(delta-t) = 0).\r\ + \n " + statistical-far-end-lm-parameters: + description: "This attribute contains the statistical far end performnace\ + \ parameters." + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + statistical-near-end-lm-parameters: + description: "This attribute contains the statistical near end performnace\ + \ parameters." + $ref: "#/definitions/tapi.eth.StatisticalLmPerformanceParameters" + total-counters-near-end-lm-parameters: + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the ingress direction." + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" + total-counters-far-end-lm-parameters: + description: "This attribute contains the results of an on-demand synthetic\ + \ loss measurement job in the egress direction." + $ref: "#/definitions/tapi.eth.TotalCountersLmPerformanceParameters" + tapi.eth.EthProActiveMeasurementJobControlSink: + allOf: + - $ref: "#/definitions/tapi.eth.EthMeasurementJobControlCommon" + - type: "object" + properties: + sink-mep-id: + type: "integer" + format: "int32" + description: "none" + source-address: + type: "string" + description: "This attribute contains the MAC address of the peer MEP. See\ + \ G.8013 for details." + is-enabled: + type: "boolean" + description: "This attribute identifies the state of the measurement job.\ + \ If set to TRUE, the MEP performs proactive Performance Measurement." + default: true + description: "This object class allows the control of the proactive 1-way measurement.\ + \ It is created as a part of an establishProActiveDualEndedMeasurementJobSink()\ + \ operation. Lifecycle: A pre-condition of deleting the object is that the\ + \ Enable attribute should have the value FALSE." + tapi.eth.EthProActiveMeasurementJobControlSource: + allOf: + - $ref: "#/definitions/tapi.eth.EthMeasurementJobControlCommon" + - type: "object" + properties: + data-tlv-length: + type: "integer" + format: "int32" + description: "This parameter provides the size of the optional data TLV.\r\ + \n Non-negative integer represents the number of bytes\ + \ for the length of the padding TLV.\r\n Notes:\r\n \ + \ When configuring this parameter one should be aware of the\ + \ maximum allowed total frame size limitation.\r\n The\ + \ attribute is not used in case of 2-way loss measurement.\r\n \ + \ range of type : Depends on the allowed MTU size." + destination-address: + type: "string" + description: "This attribute provides the Unicast MAC address of the intented\ + \ destination." + controller-mep-id: + type: "integer" + format: "int32" + description: "none" + is-enabled: + type: "boolean" + description: "This attribute identifies the state of the measurement job.\ + \ If set to TRUE, the MEP performs proactive Performance Measurement." + default: true + description: "This object class represents a proactive measurement job controller\ + \ source for 1way measurements. It is created as a part of an establishProactiveDualEndedMeasurementJobSource()\ + \ operation." + tapi.eth.EthProActiveSingleEndedMeasurementJob: + type: "object" + properties: + eth-pro-active-measurement-job-control-source: + description: "none" + $ref: "#/definitions/tapi.eth.EthProActiveMeasurementJobControlSource" + tapi.eth.EthServiceIntefacePointSpec: + type: "object" + properties: + phy-type: + description: "This attribute identifies the PHY type of the ETY trail termination.\ + \ See IEEE 802.3 clause 30.3.2.1.2." + $ref: "#/definitions/tapi.eth.EtyPhyType" + phy-type-list: + type: "array" + description: "This attribute identifies the possible PHY types that could\ + \ be supported at the ETY trail termination. See IEEE 802.3 clause 30.3.2.1.3." + items: + $ref: "#/definitions/tapi.eth.EtyPhyType" + tapi.eth.EthTerminationCommonPac: + type: "object" + properties: + filter-config-1: + type: "array" + description: "This attribute models the ETHx/ETH-m_A_Sk_MI_Filter_Config information\ + \ defined in G.8021.\r\n It indicates the configured filter\ + \ action for each of the 33 group MAC addresses for control frames.\r\n\ + \ The 33 MAC addresses are:\r\n 01-80-C2-00-00-10,\ + \ \r\n 01-80-C2-00-00-00 to 01-80-C2-00-00-0F, and \r\n \ + \ 01-80-C2-00-00-20 to 01-80-C2-00-00-2F.\r\n \ + \ The filter action is Pass or Block. \r\n If the destination\ + \ address of the incoming ETH_CI_D matches one of the above addresses, the\ + \ filter process shall perform the corresponding configured filter action.\ + \ \r\n If none of the above addresses match, the ETH_CI_D\ + \ is passed.\r\n " + items: + type: "string" + ether-type: + description: "This attribute models the ETHx/ETH-m _A_Sk_MI_Etype information\ + \ defined in G.8021." + $ref: "#/definitions/tapi.eth.VlanType" + priority-code-point-config: + description: "This attribute models the ETHx/ETH-m _A_Sk_MI_PCP_Config information\ + \ defined in G.8021." + $ref: "#/definitions/tapi.eth.PcpCoding" + frametype-config: + description: "This attribute models the ETHx/ETH-m_A_Sk_MI_Frametype_Config\ + \ information defined in G.8021." + $ref: "#/definitions/tapi.eth.FrameType" + port-vid: + type: "string" + description: "This attribute models the ETHx/ETH-m _A_Sk_MI_PVID information\ + \ defined in G.8021." + default: "1" + priority-regenerate: + description: "This attribute models the ETHx/ETH-m _A_Sk_MI_P_Regenerate information\ + \ defined in G.8021." + $ref: "#/definitions/tapi.eth.PriorityMapping" + tapi.eth.EthTerminationPac: + type: "object" + properties: + eth-termination-common-pac: + description: "none" + $ref: "#/definitions/tapi.eth.EthTerminationCommonPac" + tapi.eth.EthTestJob: + type: "object" + properties: + number: + type: "integer" + format: "int32" + description: "This parameter specifies how many TST messages to be sent." + destination-address: + type: "string" + description: "G.8052: This parameter provides the destination address, i.e.,\ + \ the MAC Address of the target MEP or MIP." + test-pattern: + type: "string" + description: "G.8052: This parameter provides the test pattern to be used\ + \ in the optional Data TLV.\r\n Examples of test patterns\ + \ include pseudo-random bit sequence (PRBS) 2^31-1 as specified in clause\ + \ 5.8 of [ITU-T O.150], all '0' pattern, etc." + eth-test-job-sink-point: + description: "none" + $ref: "#/definitions/tapi.eth.EthTestJobSinkPoint" + eth-oam-test-loopback-common-pac: + description: "none" + $ref: "#/definitions/tapi.eth.EthOamTestLoopbackCommonPac" + tapi.eth.EthTestJobSinkPoint: + type: "object" + properties: + source-address: + type: "string" + description: "This attribute contains the MAC address of the peer MEP." + tapi.eth.EthTestResultData: + type: "object" + properties: + sent-tst-frames: + type: "integer" + format: "int32" + description: "G.8052: This parameter returns the total number of sent TST\ + \ frames.\r\n Optional in case of sink only MEP." + rec-tst-frames: + type: "integer" + format: "int32" + description: "Received TST frames. Optional in case of source only MEP." + tapi.eth.EtyPac: + type: "object" + properties: + phy-type: + description: "This attribute identifies the PHY type of the ETY trail termination.\ + \ See IEEE 802.3 clause 30.3.2.1.2." + $ref: "#/definitions/tapi.eth.EtyPhyType" + phy-type-list: + type: "array" + description: "This attribute identifies the possible PHY types that could\ + \ be supported at the ETY trail termination. See IEEE 802.3 clause 30.3.2.1.3." + items: + $ref: "#/definitions/tapi.eth.EtyPhyType" + tapi.eth.EtyPhyType: + type: "string" + enum: + - "OTHER" + - "UNKNOWN" + - "NONE" + - "2BASE_TL" + - "10MBIT_S" + - "10PASS_TS" + - "100BASE_T4" + - "100BASE_X" + - "100BASE_T2" + - "1000BASE_X" + - "1000BASE_T" + - "10GBASE-X" + - "10GBASE_R" + - "10GBASE_W" + tapi.eth.EtyTerminationCommonPac: + type: "object" + properties: + is-fts-enabled: + type: "boolean" + description: "This attribute indicates whether Forced Transmitter Shutdown\ + \ (FTS) is enabled or not. It models the ETYn_TT_So_MI_FTSEnable information." + default: false + is-tx-pause-enabled: + type: "boolean" + description: "This attribute identifies whether the Transmit Pause process\ + \ is enabled or not. It models the MI_TxPauseEnable defined in G.8021." + default: false + tapi.eth.EtyTerminationPac: + allOf: + - $ref: "#/definitions/tapi.eth.EtyPac" + - type: "object" + properties: + ety-termination-common-pac: + description: "none" + $ref: "#/definitions/tapi.eth.EtyTerminationCommonPac" + description: "none" + tapi.eth.FrameType: + type: "string" + enum: + - "ADMIT_ONLY_VLAN_TAGGED_FRAMES" + - "ADMIT_ONLY_UNTAGGED_AND_PRIORITY_TAGGED_FRAMES" + - "ADMIT_ALL_FRAMES" + tapi.eth.HistoryDataAugmentation1: + type: "object" + properties: + eth-on-demand-1-dm-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthOnDemand1DmPerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.HistoryDataAugmentation10: + type: "object" + properties: + eth-pro-active-1-dm-source-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthProActive1DmSourcePerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.HistoryDataAugmentation11: + type: "object" + properties: + eth-on-demand-dm-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthOnDemandDmPerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.HistoryDataAugmentation12: + type: "object" + properties: + eth-pro-active-lm-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthProActiveLmPerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.HistoryDataAugmentation2: + type: "object" + properties: + eth-on-demand-1-dm-source-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthOnDemand1DmSourcePerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.HistoryDataAugmentation3: + type: "object" + properties: + eth-on-demand-1-lm-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthOnDemand1LmPerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.HistoryDataAugmentation4: + type: "object" + properties: + eth-pro-active-1-lm-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthProActive1LmPerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.HistoryDataAugmentation5: + type: "object" + properties: + eth-pro-active-dm-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthProActiveDmPerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.HistoryDataAugmentation6: + type: "object" + properties: + eth-pro-active-1-lm-source-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthProActive1LmSourcePerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.HistoryDataAugmentation7: + type: "object" + properties: + eth-on-demand-lm-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthOnDemandLmPerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.HistoryDataAugmentation8: + type: "object" + properties: + eth-on-demand-1-lm-source-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthOnDemand1LmSourcePerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.HistoryDataAugmentation9: + type: "object" + properties: + eth-pro-active-1-dm-performance-data: + description: "none" + $ref: "#/definitions/tapi.eth.EthProActive1DmPerformanceData" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.InputAugmentation1: + type: "object" + properties: + eth-link-trace-job: + description: "none" + $ref: "#/definitions/tapi.eth.EthLinkTraceJob" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.InputAugmentation2: + type: "object" + properties: + eth-loopback-job: + description: "none" + $ref: "#/definitions/tapi.eth.EthLoopbackJob" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.InputAugmentation3: + type: "object" + properties: + eth-test-job: + description: "none" + $ref: "#/definitions/tapi.eth.EthTestJob" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.InputAugmentation4: + type: "object" + properties: + eth-pro-active-single-ended-measurement-job: + description: "none" + $ref: "#/definitions/tapi.eth.EthProActiveSingleEndedMeasurementJob" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.InputAugmentation5: + type: "object" + properties: + eth-on-demand-dual-ended-measurement-job: + description: "none" + $ref: "#/definitions/tapi.eth.EthOnDemandDualEndedMeasurementJob" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.InputAugmentation6: + type: "object" + properties: + eth-on-demand-single-ended-measurement-job: + description: "none" + $ref: "#/definitions/tapi.eth.EthOnDemandSingleEndedMeasurementJob" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.InputAugmentation7: + type: "object" + properties: + eth-pro-active-dual-ended-measurement-job: + description: "none" + $ref: "#/definitions/tapi.eth.EthProActiveDualEndedMeasurementJob" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.LinkTraceResult: + type: "object" + properties: + data-tlv-length: + type: "integer" + format: "int32" + description: "G.8052: This attribute contains the length (in number of octets)\ + \ of the Data TLV of an individual LTR frame result." + time-to-live: + type: "integer" + format: "int32" + description: "G.8052: This attribute contains the Time To Live (TTL) value\ + \ of an individual LTR frame result." + source-address: + type: "string" + description: "G.8052: This attribute contains the source MAC Address of an\ + \ individual LTR frame result." + tapi.eth.LldpChassisIdSubtype: + type: "object" + properties: + mac-address: + type: "string" + description: "Represents a chassis identifier based on the value of a unicast\ + \ source address (encoded in network byte order and IEEE 802.3 canonical\ + \ bit order), of a port on the containing chassis as defined in IEEE Std\ + \ 802-2001." + chassis-component: + type: "string" + description: "String length '0..32'\r\n Represents a chassis\ + \ identifier based on the value of entPhysicalAlias object (defined in IETF\ + \ RFC 2737) for a chassis component (i.e., an entPhysicalClass value of\ + \ chassis(3))." + interface-name: + type: "string" + description: "Represents a chassis identifier based on the value of ifName\ + \ object (defined in IETF RFC 2863) for an interface on the containing chassis." + network-address: + type: "string" + description: "Octet string that identifies a particular network address family\ + \ and an associated network address that are encoded in network octet order.\r\ + \n An IP address, for example, would be encoded with the\ + \ first octet containing the IANA Address Family Numbers enumeration value\ + \ for the specific address type and octets 2 through n containing the address\ + \ value." + interface-alias: + type: "string" + description: "String length '0..64'\r\n Represents a chassis\ + \ identifier based on the value of ifAlias object (defined in IETF RFC 2863)\ + \ for an interface on the containing chassis." + port-component: + type: "string" + description: "String length '0..32'\r\n Represents a chassis\ + \ identifier based on the value of entPhysicalAlias object (defined in IETF\ + \ RFC 2737) for a port or backplane component (i.e., entPhysicalClass value\ + \ of port(10) or backplane(4)), within the containing chassis." + local: + type: "string" + description: "Represents a chassis identifier based on a locally defined value." + tapi.eth.LldpPortIdSubtype: + type: "object" + properties: + agent-circuit-id: + type: "string" + description: "Represents a port identifier based on the agent-local identifier\ + \ of the circuit (defined in RFC 3046), detected by the agent and associated\ + \ with a particular port." + mac-address: + type: "string" + description: "Represents a port identifier based on a unicast source address\ + \ (encoded in network byte order and IEEE 802.3 canonical bit order), which\ + \ has been detected by the agent and associated with a particular port (IEEE\ + \ Std 802-2001)." + interface-name: + type: "string" + description: "String length '0..64'\r\n Represents a port identifier\ + \ based on the ifName MIB object, defined in IETF RFC 2863." + network-address: + type: "string" + description: "Represents a port identifier based on a network address, detected\ + \ by the agent and associated with a particular port.\r\n \ + \ Octet string that identifies a particular network address family and\ + \ an associated network address that are encoded in network octet order.\r\ + \n An IP address, for example, would be encoded with the\ + \ first octet containing the IANA Address Family Numbers enumeration value\ + \ for the specific address type and octets 2 through n containing the address\ + \ value.\r\n " + interface-alias: + type: "string" + description: "String length '0..64'\r\n Represents a port identifier\ + \ based on the ifAlias MIB object, defined in IETF RFC 2863." + port-component: + type: "string" + description: "String length '0..32'\r\n Represents a port identifier\ + \ based on the value of entPhysicalAlias (defined in IETF RFC 2737) for\ + \ a port component (i.e., entPhysicalClass value of port(10)), within the\ + \ containing chassis." + local: + type: "string" + description: "Represents a port identifier based on a value locally assigned." + tapi.eth.MaintenanceAssociationName: + type: "object" + properties: + char-string: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ RFC2579 DisplayString, except that the character codes 0-31 (decimal)\ + \ are not used.\r\n Length '1..45'" + ieee-reserved: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n Reserved for definition\ + \ by IEEE 802.1. Recommend not to use zero unless absolutely needed.\r\n\ + \ Length '1..45'." + default: "0" + unsigned-int-16: + type: "integer" + format: "int32" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ 2-octet integer/big endian." + icc-format: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n ICC-based format as\ + \ specified in ITU-T Y.1731.\r\n Length '1..45'" + primary-vlan-id: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ Primary VLAN ID. 12 bits represented in a 2-octet integer." + rfc-2865-vpn-id: + type: "string" + description: "IEEE P802.1Qcx/D0.3:\r\n MEF 38:\r\n \ + \ RFC2685 VPN ID. 3 octet VPN authority Organizationally Unique Identifier\ + \ followed by 4 octet VPN index identifying VPN according to the OUI.\r\n\ + \ Length '1..45';" + tapi.eth.MegAugmentation1: + type: "object" + properties: + eth-meg-spec: + description: "none" + $ref: "#/definitions/tapi.eth.EthMegSpec" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.MepAugmentation1: + type: "object" + properties: + eth-mep-spec: + description: "none" + $ref: "#/definitions/tapi.eth.EthMepSpec" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.MipAugmentation1: + type: "object" + properties: + eth-mip-spec: + description: "none" + $ref: "#/definitions/tapi.eth.EthMipSpec" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.OamJobAugmentation1: + type: "object" + properties: + eth-loopback-job: + description: "none" + $ref: "#/definitions/tapi.eth.EthLoopbackJob" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.OamJobAugmentation2: + type: "object" + properties: + eth-test-job: + description: "none" + $ref: "#/definitions/tapi.eth.EthTestJob" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.OamJobAugmentation3: + type: "object" + properties: + eth-link-trace-job: + description: "none" + $ref: "#/definitions/tapi.eth.EthLinkTraceJob" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.OamJobAugmentation4: + type: "object" + properties: + eth-on-demand-single-ended-measurement-job: + description: "none" + $ref: "#/definitions/tapi.eth.EthOnDemandSingleEndedMeasurementJob" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.OamJobAugmentation5: + type: "object" + properties: + eth-pro-active-single-ended-measurement-job: + description: "none" + $ref: "#/definitions/tapi.eth.EthProActiveSingleEndedMeasurementJob" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.OamJobAugmentation6: + type: "object" + properties: + eth-pro-active-dual-ended-measurement-job: + description: "none" + $ref: "#/definitions/tapi.eth.EthProActiveDualEndedMeasurementJob" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.OamJobAugmentation7: + type: "object" + properties: + eth-on-demand-dual-ended-measurement-job: + description: "none" + $ref: "#/definitions/tapi.eth.EthOnDemandDualEndedMeasurementJob" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.OamPduGenerationType: + type: "string" + enum: + - "SINGLE_INSTANCE" + - "REPETITIVE_INSTANCE" + - "SINGLE_SERIES" + - "REPETITIVE_SERIES" + tapi.eth.OamPeriod: + type: "string" + enum: + - "3_33MS" + - "10MS" + - "100MS" + - "1S" + - "10S" + - "1MIN" + - "10MIN" + tapi.eth.OamServiceAugmentation1: + type: "object" + properties: + eth-oam-service: + description: "none" + $ref: "#/definitions/tapi.eth.EthOamService" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.OamServicePointAugmentation1: + type: "object" + properties: + eth-oam-mip-service-point: + description: "none" + $ref: "#/definitions/tapi.eth.EthOamMipServicePoint" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.OamServicePointAugmentation2: + type: "object" + properties: + eth-oam-mep-service-point: + description: "none" + $ref: "#/definitions/tapi.eth.EthOamMepServicePoint" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.OamServicePointAugmentation3: + type: "object" + properties: + eth-oam-mep-service-point: + description: "none" + $ref: "#/definitions/tapi.eth.EthOamMepServicePoint" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.PcpCoding: + type: "string" + enum: + - "8P0D" + - "7P1D" + - "6P2D" + - "5P3D" + - "DEI" + tapi.eth.PriorityConfiguration: + type: "object" + properties: + priority: + type: "integer" + format: "int32" + description: "none" + queue-id: + type: "integer" + format: "int32" + description: "none" + tapi.eth.PriorityMapping: + type: "object" + properties: + priority-0: + type: "integer" + format: "int32" + description: "This attribute defines the new priority value for the old priority\ + \ value 0." + priority-1: + type: "integer" + format: "int32" + description: "This attribute defines the new priority value for the old priority\ + \ value 1." + default: 1 + priority-2: + type: "integer" + format: "int32" + description: "This attribute defines the new priority value for the old priority\ + \ value 2." + default: 2 + priority-3: + type: "integer" + format: "int32" + description: "This attribute defines the new priority value for the old priority\ + \ value 3." + default: 3 + priority-4: + type: "integer" + format: "int32" + description: "This attribute defines the new priority value for the old priority\ + \ value 4." + default: 4 + priority-5: + type: "integer" + format: "int32" + description: "This attribute defines the new priority value for the old priority\ + \ value 5." + default: 5 + priority-6: + type: "integer" + format: "int32" + description: "This attribute defines the new priority value for the old priority\ + \ value 6." + default: 6 + priority-7: + type: "integer" + format: "int32" + description: "This attribute defines the new priority value for the old priority\ + \ value 7." + default: 7 + tapi.eth.QueueConfiguration: + type: "object" + properties: + queue-threshold: + type: "integer" + format: "int32" + description: "This attribute defines the threshold of the queue in bytes." + queue-id: + type: "integer" + format: "int32" + description: "This attribute indicates the queue id." + queue-depth: + type: "integer" + format: "int32" + description: "This attribute defines the depth of the queue in bytes." + tapi.eth.RepetitionPeriod: + type: "string" + enum: + - "1MIN" + - "1S" + - "10S" + - "0" + tapi.eth.SamplesDmPerformanceParameters: + type: "object" + properties: + frame-delay-variation-list: + type: "array" + description: "This attribute contains the frame delay variations measured\ + \ in ns (nano second). The multiplicity is defined by (numberOfSamples\ + \ - 1, for numberOfSamples > 0)." + items: + type: "integer" + format: "int32" + number-of-samples: + type: "integer" + format: "int32" + description: "This attribute contains the number of received DM frames (successful\ + \ samples) used for this frame delay measurement.\r\n range\ + \ of type : non-negative" + frame-delay-list: + type: "array" + description: "This attribute contains the frame delays measured in ns (nano\ + \ second, 1x10e-9 seconds). The multiplicity is defined by the numberOfSamples\ + \ attribute." + items: + type: "integer" + format: "int32" + tapi.eth.ServiceAugmentation1: + type: "object" + properties: + eth-connectivity-service: + description: "none" + $ref: "#/definitions/tapi.eth.EthConnectivityService" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.ServiceInterfacePointAugmentation1: + type: "object" + properties: + eth-service-inteface-point-spec: + description: "none" + $ref: "#/definitions/tapi.eth.EthServiceIntefacePointSpec" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.SipAugmentation1: + type: "object" + properties: + eth-service-inteface-point-spec: + description: "none" + $ref: "#/definitions/tapi.eth.EthServiceIntefacePointSpec" + x-augmentation: + prefix: "tapi-eth" + namespace: "urn:onf:otcc:yang:tapi-eth" + tapi.eth.StatisticalDmPerformanceParameters: + type: "object" + properties: + average-frame-delay: + type: "integer" + format: "int32" + description: "This attribute contains the average frame delay observed over\ + \ the monitored period. It is measured in units of ns (nano second, 1x10e-9\ + \ seconds)." + maximum-frame-delay: + type: "integer" + format: "int32" + description: "This attribute contains the maximum frame delay observed over\ + \ the monitored period. It is measured in units of ns (nano second, 1x10e-9\ + \ seconds)." + average-inter-frame-delay-variation: + type: "integer" + format: "int32" + description: "This attribute contains the average frame delay variation measured\ + \ in units of ns (nano second, 1x10e-9 seconds).\r\n G.8013/Y.1731:\r\ + \n Frame delay variation is a measure of the variations in\ + \ the frame delay between a pair of service frames" + minimum-frame-delay: + type: "integer" + format: "int32" + description: "This attribute contains the minimum frame delay observed over\ + \ the monitored period. It is measured in units of ns (nano second, 1x10e-9\ + \ seconds)." + maximum-frame-delay-variation: + type: "integer" + format: "int32" + description: "This attribute contains the maximum frame delay variation measured\ + \ in units of ns (nano second, 1x10e-9 seconds).\r\n Y.1563:\r\ + \n The 2-point frame delay variation (vk) for an Ethernet\ + \ frame k between SRC and DST is the difference between the absolute Ethernet\ + \ frame transfer delay (xk) of frame k and a defined reference Ethernet\ + \ frame transfer delay, d1,2, between those same MPs: vk = xk – d1,2." + minimum-frame-delay-variation: + type: "integer" + format: "int32" + description: "This attribute contains the minimum frame delay variation measured\ + \ in units of ns (nano second, 1x10e-9 seconds).\r\n Y.1563:\r\ + \n The 2-point frame delay variation (vk) for an Ethernet\ + \ frame k between SRC and DST is the difference between the absolute Ethernet\ + \ frame transfer delay (xk) of frame k and a defined reference Ethernet\ + \ frame transfer delay, d1,2, between those same MPs: vk = xk – d1,2." + minimum-inter-frame-delay-variation: + type: "integer" + format: "int32" + description: "This attribute contains the minimum frame delay variation measured\ + \ in units of ns (nano second, 1x10e-9 seconds).\r\n G.8013/Y.1731:\r\ + \n Frame delay variation is a measure of the variations in\ + \ the frame delay between a pair of service frames" + maximum-inter-frame-delay-variation: + type: "integer" + format: "int32" + description: "This attribute contains the maximum frame delay variation measured\ + \ in units of ns (nano second, 1x10e-9 seconds).\r\n G.8013/Y.1731:\r\ + \n Frame delay variation is a measure of the variations in\ + \ the frame delay between a pair of service frames" + average-frame-delay-variation: + type: "integer" + format: "int32" + description: "This attribute contains the average frame delay variation measured\ + \ in units of ns (nano second, 1x10e-9 seconds).\r\n Y.1563:\r\ + \n The 2-point frame delay variation (vk) for an Ethernet\ + \ frame k between SRC and DST is the difference between the absolute Ethernet\ + \ frame transfer delay (xk) of frame k and a defined reference Ethernet\ + \ frame transfer delay, d1,2, between those same MPs: vk = xk – d1,2." + tapi.eth.StatisticalLmPerformanceParameters: + type: "object" + properties: + average-frame-loss-ratio: + type: "string" + description: "This attribute contains the average frame loss ratio calculated\ + \ over a period of time." + unavailable-intervals: + type: "integer" + format: "int32" + description: "A generalized UAS.\r\n MEF 35.1: A 32-bit counter\ + \ reflecting the number of delta-t intervals evaluated as Unavailable (i.e.,\ + \ for which A(delta-t) = 0).\r\n range\ + \ of type : 0..900 for 15min interval or 0..86400 for 24 hr interval." + hli-count: + type: "integer" + format: "int32" + description: "A generalized SES.\r\n MEF 10.3: The Resiliency\ + \ attributes are similar to the definitions of Severely Errored Seconds\ + \ (SES) and Consecutive SES in section 9 and Annex B (respectively) of Y.1563\ + \ [6], when delta-t = 1 second.\r\n MEF 35.1: Count of High\ + \ Loss Intervals during the Measurement Interval.\r\n range\ + \ of type : 0..900 for 15min interval or 0..86400 for 24 hr interval." + maximum-frame-loss-ratio: + type: "string" + description: "This attribute contains the maximum frame loss ratio calculated\ + \ over a period of time." + minimum-frame-loss-ratio: + type: "string" + description: "This attribute contains the minimum frame loss ratio calculated\ + \ over a period of time." + tapi.eth.TotalCountersLmPerformanceParameters: + type: "object" + properties: + total-transmitted-frames: + type: "integer" + format: "int32" + description: "This attribute contains the total number of frames transmitted." + total-frame-loss-ratio: + type: "string" + description: "This attribute contains the frame loss ratio (number of lost\ + \ frames divided by the number of total frames (N_LF / N_TF)).\r\n \ + \ The accuracy of the value is for further study." + total-lost-frames: + type: "integer" + format: "int32" + description: "This attribute contains the total number of frames lost." + tapi.eth.TrafficConditioningConfiguration: + type: "object" + properties: + queue-id: + type: "integer" + format: "int32" + description: "This attribute indicates the queue id." + coupling-flag: + type: "boolean" + description: "This attribute indicates the coupling flag." + default: false + cbs: + type: "integer" + format: "int32" + description: "This attribute indicates the Committed Burst Size in bytes." + ebs: + type: "integer" + format: "int32" + description: "This attribute indicates the Excess Burst Size in bytes." + colour-mode: + description: "This attribute indicates the colour mode." + $ref: "#/definitions/tapi.eth.ColourMode" + cir: + type: "integer" + format: "int32" + description: "This attribute indicates the Committed Information Rate in bits/s." + eir: + type: "integer" + format: "int32" + description: "This attribute indicates the Excess Information Rate in bits/s." + tapi.eth.TrafficConditioningPac: + type: "object" + properties: + codirectional: + type: "boolean" + description: "This attribute indicates the direction of the conditioner. The\ + \ value of true means that the conditioner (modeled as a TCS Sink according\ + \ to G.8021) is associated with the sink part of the containing CTP. The\ + \ value of false means that the conditioner (modeled as a TCS Sink according\ + \ to G.8021) is associated with the source part of the containing CTP." + default: false + prio-config-list: + type: "array" + description: "This attribute indicates the Priority Splitter function for\ + \ the mapping of the Ethernet frame priority (ETH_CI_P) values to the output\ + \ queue." + items: + $ref: "#/definitions/tapi.eth.PriorityConfiguration" + cond-config-list: + type: "array" + description: "This attribute indicates for the conditioner process the conditioning\ + \ parameters:\r\n - Queue ID: Indicates the Queue ID\r\n\ + \ - Committed Information Rate (CIR): number of bits per\ + \ second\r\n - Committed Burst Size (CBS): number of bytes\r\ + \n - Excess Information Rate (EIR): number of bits per second\r\ + \n - Excess Burst Size (EBS): number of bytes\r\n \ + \ - Coupling flag (CF): 0 or 1\r\n - Color mode (CM):\ + \ color-blind and color-aware." + items: + $ref: "#/definitions/tapi.eth.TrafficConditioningConfiguration" + tapi.eth.TrafficShapingPac: + type: "object" + properties: + codirectional: + type: "boolean" + description: "This attribute indicates the direction of the shaping function.\ + \ The value of true means that the shaping (modeled as a TCS Source according\ + \ to G.8021) is associated with the source part of the containing CTP. The\ + \ value of false means that the shaping (modeled as a TCS Source according\ + \ to G.8021) is associated with the sink part of the containing CTP." + default: false + sched-config: + type: "string" + description: "This attribute configures the scheduler process. The value of\ + \ this attribute is for further study because it is for further study in\ + \ G.8021.\r\n Scheduler is a pointer to a Scheduler object,\ + \ which is to be defined in the future (because in G.8021, this is FFS).\r\ + \n Note that the only significance of the GTCS function defined\ + \ in G.8021 is the use of a common scheduler for shaping. Given that, G.8052\ + \ models the common scheduler feature by having a common value for this\ + \ attribute." + queue-config-list: + type: "array" + description: "This attribute configures the Queue depth and Dropping threshold\ + \ parameters of the Queue process. The Queue depth sets the maximum size\ + \ of the queue in bytes. An incoming ETH_CI traffic unit is dropped if there\ + \ is insufficient space in the queue to hold the whole unit. The Dropping\ + \ threshold sets the threshold of the queue. If the queue is filled beyond\ + \ this threshold, incoming ETH_CI traffic units accompanied by the ETH_CI_DE\ + \ signal set are dropped." + items: + $ref: "#/definitions/tapi.eth.QueueConfiguration" + prio-config-list: + type: "array" + description: "This attribute configures the Priority Splitter function for\ + \ the mapping of the Ethernet frame priority (ETH_CI_P) values to the output\ + \ queue." + items: + $ref: "#/definitions/tapi.eth.PriorityConfiguration" + tapi.eth.VlanType: + type: "string" + enum: + - "C_Tag" + - "S_Tag" + - "I_Tag" + tapi.notification.ContextAugmentation1: + type: "object" + properties: + notification-context: + description: "Augments the base TAPI Context with NotificationService information" + $ref: "#/definitions/tapi.notification.context.NotificationContext" + x-augmentation: + prefix: "tapi-notification" + namespace: "urn:onf:otcc:yang:tapi-notification" + tapi.notification.CreateNotificationSubscriptionService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Output" + tapi.notification.GetNotificationList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationlist.Output" + tapi.notification.GetNotificationSubscriptionServiceDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Output" + tapi.notification.GetNotificationSubscriptionServiceList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicelist.Output" + tapi.notification.GetSupportedNotificationTypes: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getsupportednotificationtypes.Output" + tapi.notification.NameAndValueChange: + type: "object" + properties: + value-name: + type: "string" + description: "The name of the value. The value need not have a name." + old-value: + type: "string" + description: "The value" + new-value: + type: "string" + description: "The value" + tapi.notification.Notification: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + target-object-type: + type: "string" + description: "none" + additional-text: + type: "string" + description: "none" + event-time-stamp: + type: "string" + description: "none" + additional-info: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.NameAndValue" + sequence-number: + type: "integer" + format: "int32" + description: "A monotonous increasing sequence number associated with the\ + \ notification.\r\n The exact semantics of how this sequence\ + \ number is assigned (per channel or subscription or source or system)\ + \ is left undefined." + target-object-identifier: + type: "string" + description: "none" + notification-type: + type: "string" + description: "none" + target-object-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.NameAndValue" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + source-indicator: + description: "none" + $ref: "#/definitions/tapi.notification.SourceIndicator" + layer-protocol-qualifier: + type: "string" + description: "none" + changed-attributes: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + description: "none" + tapi.notification.NotificationChannel: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + next-sequence-no: + type: "integer" + format: "int32" + description: "The sequence number of the next notification that will be\ + \ published on the channel" + stream-address: + type: "string" + description: "The address/location/URI of the channel/stream to which the\ + \ subscribed notifications are published.\r\n This specifics\ + \ of this is typically dependent on the implementation protocol & mechanism\ + \ and hence is typed as a string." + description: "none" + tapi.notification.NotificationSubscriptionService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.Notification" + notification-channel: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationChannel" + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + supported-object-types: + type: "array" + description: "none" + items: + type: "string" + supported-notification-types: + type: "array" + description: "none" + items: + type: "string" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + description: "none" + tapi.notification.SourceIndicator: + type: "string" + enum: + - "RESOURCE_OPERATION" + - "MANAGEMENT_OPERATION" + - "UNKNOWN" + tapi.notification.SubscriptionFilter: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + requested-notification-types: + type: "array" + description: "none" + items: + type: "string" + requested-object-identifier: + type: "array" + description: "none" + items: + type: "string" + requested-layer-protocols: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + include-content: + type: "boolean" + description: "Indicates whether the published Notification includes content\ + \ or just the Notification Id (which enables retrieval of the notification\ + \ at the later stage)" + default: false + requested-object-types: + type: "array" + description: "none" + items: + type: "string" + description: "none" + tapi.notification.SubscriptionState: + type: "string" + enum: + - "SUSPENDED" + - "ACTIVE" + tapi.notification.UpdateNotificationSubscriptionService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Output" + tapi.notification.context.NotificationContext: + allOf: + - type: "object" + properties: + notif-subscription: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" + description: "Augments the base TAPI Context with NotificationService information" + tapi.notification.createnotificationsubscriptionservice.Input: + type: "object" + properties: + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + tapi.notification.createnotificationsubscriptionservice.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.deletenotificationsubscriptionservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationlist.Input: + type: "object" + properties: + time-range: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + subscription-id: + type: "string" + description: "UUID of the associated Notification Subscription Service: An\ + \ identifier that is universally unique within an identifier space, where\ + \ the identifier space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationlist.Output: + type: "object" + properties: + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" + tapi.notification.getnotificationsubscriptionservicedetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationsubscriptionservicedetails.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.getnotificationsubscriptionservicelist.Output: + type: "object" + properties: + subscription-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.getsupportednotificationtypes.Output: + type: "object" + properties: + supported-object-types: + type: "array" + description: "none" + items: + type: "string" + supported-notification-types: + type: "array" + description: "none" + items: + type: "string" + tapi.notification.notificationcontext.Notification: + allOf: + - $ref: "#/definitions/tapi.notification.Notification" + - $ref: "#/definitions/tapi.oam.NotificationAugmentation1" + - $ref: "#/definitions/tapi.oam.NotificationAugmentation2" + tapi.notification.updatenotificationsubscriptionservice.Input: + type: "object" + properties: + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + tapi.notification.updatenotificationsubscriptionservice.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.oam.AlarmInfo: + type: "object" + properties: + perceived-severity: + description: "none" + $ref: "#/definitions/tapi.oam.PerceivedSeverityType" + probable-cause: + type: "string" + description: "none" + service-affecting: + description: "none" + $ref: "#/definitions/tapi.oam.ServiceAffecting" + is-transient: + type: "boolean" + description: "none" + default: false + tapi.oam.ConnectionEndPointAugmentation1: + type: "object" + properties: + mep-mip-list: + description: "none" + $ref: "#/definitions/tapi.oam.MepMipList" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" + tapi.oam.ContextAugmentation3: + type: "object" + properties: + oam-context: + description: "Augments the base TAPI Context with OamService information" + $ref: "#/definitions/tapi.oam.context.OamContext" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" + tapi.oam.CreateOamJob: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.createoamjob.Output" + tapi.oam.CreateOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.createoamprofile.Output" + tapi.oam.CreateOamService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.createoamservice.Output" + tapi.oam.CreateOamServicePoint: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.createoamservicepoint.Output" + tapi.oam.CurrentData: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + elapsed-time: + description: "none" + $ref: "#/definitions/tapi.common.TimeInterval" + period-start-time: + type: "string" + description: "This attribute indicates the start of the current monitoring\ + \ interval.\r\n The value is bound to the quarter of an\ + \ hour in case of a 15 minute interval and bound to the hour in case of\ + \ a 24 hour interval." + pm-data-pac: + description: "none" + $ref: "#/definitions/tapi.oam.PmDataPac" + history-data: + type: "array" + description: "in case of 24hr Current Data, at least 1 History Data.\r\n\ + \ In case of 15min Current Data, at least 16 History Data.\r\ + \n In case of <15min, the number of History Data shall\ + \ be able to cover a span of 4 hours." + items: + $ref: "#/definitions/tapi.oam.HistoryData" + description: "none" + tapi.oam.GetMeg: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getmeg.Output" + tapi.oam.GetOamJob: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamjob.Output" + tapi.oam.GetOamJobList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamjoblist.Output" + tapi.oam.GetOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamprofile.Output" + tapi.oam.GetOamProfileList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamprofilelist.Output" + tapi.oam.GetOamService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamservice.Output" + tapi.oam.GetOamServiceList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamservicelist.Output" + tapi.oam.GetOamServicePoint: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamservicepoint.Output" + tapi.oam.HistoryData: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + period-start-time: + type: "string" + description: "This attribute indicates the start of the monitoring interval.\r\ + \n The value is bound to the quarter of an hour in case\ + \ of a 15 minute interval and bound to the hour in case of a 24 hour interval." + pm-data-pac: + description: "none" + $ref: "#/definitions/tapi.oam.PmDataPac" + period-end-time: + type: "string" + description: "none" + description: "none" + tapi.oam.MegRef: + type: "object" + properties: + meg-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:uuid" + tapi.oam.Mep: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - $ref: "#/definitions/tapi.common.OperationalStatePac" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + description: "none" + tapi.oam.MepMipList: + type: "object" + properties: + mip: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.MipRef" + mep: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.MepRef" + tapi.oam.MepRef: + allOf: + - $ref: "#/definitions/tapi.oam.MegRef" + - type: "object" + properties: + mep-local-id: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:mep/tapi-oam:local-id" + description: "none" + tapi.oam.Mip: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + description: "none" + tapi.oam.MipRef: + allOf: + - $ref: "#/definitions/tapi.oam.MegRef" + - type: "object" + properties: + mip-local-id: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:mip/tapi-oam:local-id" + description: "none" + tapi.oam.NotificationAugmentation1: + type: "object" + properties: + tca-info: + description: "none" + $ref: "#/definitions/tapi.oam.TcaInfo" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" + tapi.oam.NotificationAugmentation2: + type: "object" + properties: + alarm-info: + description: "none" + $ref: "#/definitions/tapi.oam.AlarmInfo" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" + tapi.oam.OamJob: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + schedule: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + oam-profile: + description: "none" + $ref: "#/definitions/tapi.oam.OamProfileRef" + creation-time: + type: "string" + description: "none" + oam-job-type: + type: "string" + description: "none" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamServicePointRef" + current-data: + type: "array" + description: "Granularity period of the CurrentData identifies the specific\ + \ CurrentData instance in the scope of this OamJob.\r\n \ + \ For example, typically at least\r\n one 15min and\r\n\ + \ one 24hr;\r\n optionally one additional\ + \ configurable (< 15min)" + items: + $ref: "#/definitions/tapi.oam.CurrentData" + description: "none" + tapi.oam.OamJobRef: + type: "object" + properties: + oam-job-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-job/tapi-oam:uuid" + tapi.oam.OamProfile: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + pm-threshold-data: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.PmThresholdData" + description: "none" + tapi.oam.OamProfileRef: + type: "object" + properties: + oam-profile-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-profile/tapi-oam:uuid" + tapi.oam.OamServicePoint: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + mip: + description: "none" + $ref: "#/definitions/tapi.oam.MipRef" + service-interface-point: + description: "none" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + is-mip: + type: "boolean" + description: "If true, the object is related to a MIP.\r\n \ + \ If false, the object is related to a MEP." + default: false + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + mep: + description: "none" + $ref: "#/definitions/tapi.oam.MepRef" + description: "none" + tapi.oam.OamServicePointRef: + allOf: + - $ref: "#/definitions/tapi.oam.OamServiceRef" + - type: "object" + properties: + oam-service-point-local-id: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:oam-service-point/tapi-oam:local-id" + description: "none" + tapi.oam.OamServiceRef: + type: "object" + properties: + oam-service-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:uuid" + tapi.oam.PerceivedSeverityType: + type: "string" + enum: + - "CRITICAL" + - "MAJOR" + - "MINOR" + - "WARNING" + - "CLEARED" + tapi.oam.PerceivedTcaSeverity: + type: "string" + enum: + - "WARNING" + - "CLEAR" + tapi.oam.PmDataPac: + type: "object" + properties: + suspect-interval-flag: + type: "boolean" + description: "This attribute is used to indicate that the performance data\ + \ for the current period may not be reliable. Some reasons for this to occur\ + \ are:\r\n – Suspect data were detected by the actual resource\ + \ doing data collection.\r\n – Transition of the administrativeState\ + \ attribute to/from the 'lock' state.\r\n – Transition of\ + \ the operationalState to/from the 'disabled' state.\r\n \ + \ – Scheduler setting that inhibits the collection function.\r\n \ + \ – The performance counters were reset during the interval.\r\n\ + \ – The currentData (or subclass) object instance was created\ + \ during the monitoring period." + default: false + granularity-period: + description: "none" + $ref: "#/definitions/tapi.common.TimePeriod" + tapi.oam.PmParameterValue: + type: "object" + properties: + pm-parameter-int-value: + type: "integer" + format: "int32" + description: "none" + pm-parameter-real-value: + type: "string" + description: "none" + tapi.oam.PmThresholdData: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + granularity-period: + description: "none" + $ref: "#/definitions/tapi.common.TimePeriod" + threshold-parameter: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.ThresholdParameter" + is-transient: + type: "boolean" + description: "none" + default: false + applicable-job-type: + type: "array" + description: "This attribute allows an PMThresholdData instance to be constrained\ + \ to specific job types. If an PMThresholdData instance is so configured\ + \ to be applicable to more than one job type (worst case ALL), only the\ + \ parameters relevant for the job instance will be used (non-applicable\ + \ profile parameters will be ignored)" + items: + type: "string" + description: "none" + tapi.oam.ServiceAffecting: + type: "string" + enum: + - "SERVICE_AFFECTING" + - "NOT_SERVICE_AFFECTING" + - "UNKNOWN" + tapi.oam.TcaInfo: + type: "object" + properties: + oam-job: + description: "MEF 35.1\r\n Identification of the PM Session\ + \ for which the TCA Function was configured." + $ref: "#/definitions/tapi.oam.OamJobRef" + threshold-parameter: + description: "none" + $ref: "#/definitions/tapi.oam.ThresholdParameter" + is-transient: + type: "boolean" + description: "none" + default: false + perceived-severity: + description: "none" + $ref: "#/definitions/tapi.oam.PerceivedTcaSeverity" + suspect-interval-flag: + type: "boolean" + description: "none" + default: false + measurement-interval: + type: "string" + description: "none" + tapi.oam.ThresholdCrossingQualifier: + type: "string" + enum: + - "NOT_APPLICABLE" + - "NEAR_END" + - "FAR_END" + - "BIDIRECTIONAL" + - "FORWARD" + - "BACKWARD" + tapi.oam.ThresholdParameter: + type: "object" + properties: + pm-parameter-below-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-clear-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-above-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-name: + type: "string" + description: "none" + threshold-location: + description: "none" + $ref: "#/definitions/tapi.oam.ThresholdCrossingQualifier" + tapi.oam.UpdateOamJob: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.updateoamjob.Output" + tapi.oam.UpdateOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.updateoamprofile.Output" + tapi.oam.UpdateOamService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.updateoamservice.Output" + tapi.oam.UpdateOamServicePoint: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.updateoamservicepoint.Output" + tapi.oam.context.OamContext: + allOf: + - type: "object" + properties: + oam-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.oamcontext.OamService" + oam-profile: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamProfile" + oam-job: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.oamcontext.OamJob" + meg: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.oamcontext.Meg" + description: "Augments the base TAPI Context with OamService information" + tapi.oam.createoamjob.Input: + allOf: + - $ref: "#/definitions/tapi.eth.InputAugmentation1" + - $ref: "#/definitions/tapi.eth.InputAugmentation2" + - $ref: "#/definitions/tapi.eth.InputAugmentation3" + - $ref: "#/definitions/tapi.eth.InputAugmentation4" + - $ref: "#/definitions/tapi.eth.InputAugmentation5" + - $ref: "#/definitions/tapi.eth.InputAugmentation6" + - $ref: "#/definitions/tapi.eth.InputAugmentation7" + - type: "object" + properties: + schedule: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + name: + type: "array" + description: "List of names. This value is unique in some namespace but\ + \ may change during the life of the entity.\r\n A name\ + \ carries no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point-id: + type: "string" + description: "UUID of the associated OSEPs: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n\ + \ UUID here uses string representation as defined in\ + \ RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of\ + \ a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + oam-job-type: + type: "string" + description: "none" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + oam-profile-id: + type: "string" + description: "UUID of the OamProfile to be applied: An identifier that is\ + \ universally unique within an identifier space, where the identifier\ + \ space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose or state\ + \ of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase\ + \ characters.\r\n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of\ + \ a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + oam-service-id: + type: "string" + description: "UUID of the associated OamService: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n\ + \ UUID here uses string representation as defined in\ + \ RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of\ + \ a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the\ + \ purpose or state of the entity.\r\n UUID here uses\ + \ string representation as defined in RFC 4122. The canonical representation\ + \ uses lowercase characters.\r\n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of\ + \ a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + description: "" + tapi.oam.createoamjob.Output: + type: "object" + properties: + oam-job: + description: "none" + $ref: "#/definitions/tapi.oam.getoamjob.output.OamJob" + tapi.oam.createoamprofile.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + pm-threshold-data: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.PmThresholdData" + tapi.oam.createoamprofile.Output: + type: "object" + properties: + oam-profile: + description: "none" + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.createoamservice.Input: + type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.createoamservice.input.OamServicePoint" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.createoamservice.Output: + type: "object" + properties: + oam-service: + description: "none" + $ref: "#/definitions/tapi.oam.createoamservice.output.OamService" + tapi.oam.createoamservice.input.OamServicePoint: + allOf: + - $ref: "#/definitions/tapi.eth.OamServicePointAugmentation1" + - $ref: "#/definitions/tapi.eth.OamServicePointAugmentation2" + - $ref: "#/definitions/tapi.eth.OamServicePointAugmentation3" + - $ref: "#/definitions/tapi.oam.OamServicePoint" + tapi.oam.createoamservice.output.OamService: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.eth.OamServiceAugmentation1" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.oamservice.OamServicePoint" + meg: + description: "none" + $ref: "#/definitions/tapi.oam.MegRef" + description: "none" + tapi.oam.createoamservicepoint.Input: + type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + connectivity-service-end-point-id: + type: "string" + description: "UUID of the CSEP to be monitored: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + service-interface-point-id: + type: "string" + description: "UUID of the associated SIP to be monitored: An identifier that\ + \ is universally unique within an identifier space, where the identifier\ + \ space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose or state of\ + \ the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + oam-service-id: + type: "string" + description: "UUID of the parent OamService: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.createoamservicepoint.Output: + type: "object" + properties: + oam-service-point: + description: "none" + $ref: "#/definitions/tapi.oam.oamservice.OamServicePoint" + tapi.oam.currentdata.HistoryData: + allOf: + - $ref: "#/definitions/tapi.eth.HistoryDataAugmentation1" + - $ref: "#/definitions/tapi.eth.HistoryDataAugmentation10" + - $ref: "#/definitions/tapi.eth.HistoryDataAugmentation11" + - $ref: "#/definitions/tapi.eth.HistoryDataAugmentation12" + - $ref: "#/definitions/tapi.eth.HistoryDataAugmentation2" + - $ref: "#/definitions/tapi.eth.HistoryDataAugmentation3" + - $ref: "#/definitions/tapi.eth.HistoryDataAugmentation4" + - $ref: "#/definitions/tapi.eth.HistoryDataAugmentation5" + - $ref: "#/definitions/tapi.eth.HistoryDataAugmentation6" + - $ref: "#/definitions/tapi.eth.HistoryDataAugmentation7" + - $ref: "#/definitions/tapi.eth.HistoryDataAugmentation8" + - $ref: "#/definitions/tapi.eth.HistoryDataAugmentation9" + - $ref: "#/definitions/tapi.oam.HistoryData" + tapi.oam.deleteoamjob.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamprofile.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamservicepoint.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getmeg.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getmeg.Output: + type: "object" + properties: + meg: + description: "none" + $ref: "#/definitions/tapi.oam.getmeg.output.Meg" + tapi.oam.getmeg.output.Meg: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.common.OperationalStatePac" + - $ref: "#/definitions/tapi.eth.MegAugmentation1" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + mep: + type: "array" + description: "1. ME may have 0 MEPs (case of transit domains where at least\ + \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case of edge\ + \ domaind, where the peer MEP is ouside the managed domain)\r\n \ + \ 3. ME may have 2 MEPs" + items: + $ref: "#/definitions/tapi.oam.meg.Mep" + mip: + type: "array" + description: "ME may 0, 1, or more MIPs" + items: + $ref: "#/definitions/tapi.oam.meg.Mip" + description: "none" + tapi.oam.getoamjob.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamjob.Output: + type: "object" + properties: + oam-job: + description: "none" + $ref: "#/definitions/tapi.oam.getoamjob.output.OamJob" + tapi.oam.getoamjob.output.OamJob: + allOf: + - $ref: "#/definitions/tapi.eth.OamJobAugmentation1" + - $ref: "#/definitions/tapi.eth.OamJobAugmentation2" + - $ref: "#/definitions/tapi.eth.OamJobAugmentation3" + - $ref: "#/definitions/tapi.eth.OamJobAugmentation4" + - $ref: "#/definitions/tapi.eth.OamJobAugmentation5" + - $ref: "#/definitions/tapi.eth.OamJobAugmentation6" + - $ref: "#/definitions/tapi.eth.OamJobAugmentation7" + - $ref: "#/definitions/tapi.oam.OamJob" + tapi.oam.getoamjoblist.Output: + type: "object" + properties: + oam-job: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.getoamjob.output.OamJob" + tapi.oam.getoamprofile.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamprofile.Output: + type: "object" + properties: + oam-profile: + description: "none" + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.getoamprofilelist.Output: + type: "object" + properties: + oam-profile: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.getoamservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamservice.Output: + type: "object" + properties: + oam-service: + description: "none" + $ref: "#/definitions/tapi.oam.getoamservice.output.OamService" + tapi.oam.getoamservice.output.OamService: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.eth.OamServiceAugmentation1" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.oamservice.OamServicePoint" + meg: + description: "none" + $ref: "#/definitions/tapi.oam.MegRef" + description: "none" + tapi.oam.getoamservicelist.Output: + type: "object" + properties: + oam-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.getoamservicelist.output.OamService" + tapi.oam.getoamservicelist.output.OamService: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.eth.OamServiceAugmentation1" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.oamservice.OamServicePoint" + meg: + description: "none" + $ref: "#/definitions/tapi.oam.MegRef" + description: "none" + tapi.oam.getoamservicepoint.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamservicepoint.Output: + type: "object" + properties: + oam-service-point: + description: "none" + $ref: "#/definitions/tapi.oam.oamservice.OamServicePoint" + tapi.oam.meg.Mep: + allOf: + - $ref: "#/definitions/tapi.eth.MepAugmentation1" + - $ref: "#/definitions/tapi.oam.Mep" + tapi.oam.meg.Mip: + allOf: + - $ref: "#/definitions/tapi.eth.MipAugmentation1" + - $ref: "#/definitions/tapi.oam.Mip" + tapi.oam.oamcontext.Meg: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.common.OperationalStatePac" + - $ref: "#/definitions/tapi.eth.MegAugmentation1" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + mep: + type: "array" + description: "1. ME may have 0 MEPs (case of transit domains where at least\ + \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case of edge\ + \ domaind, where the peer MEP is ouside the managed domain)\r\n \ + \ 3. ME may have 2 MEPs" + items: + $ref: "#/definitions/tapi.oam.meg.Mep" + mip: + type: "array" + description: "ME may 0, 1, or more MIPs" + items: + $ref: "#/definitions/tapi.oam.meg.Mip" + description: "none" + tapi.oam.oamcontext.OamJob: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.eth.OamJobAugmentation1" + - $ref: "#/definitions/tapi.eth.OamJobAugmentation2" + - $ref: "#/definitions/tapi.eth.OamJobAugmentation3" + - $ref: "#/definitions/tapi.eth.OamJobAugmentation4" + - $ref: "#/definitions/tapi.eth.OamJobAugmentation5" + - $ref: "#/definitions/tapi.eth.OamJobAugmentation6" + - $ref: "#/definitions/tapi.eth.OamJobAugmentation7" + - type: "object" + properties: + schedule: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + oam-profile: + description: "none" + $ref: "#/definitions/tapi.oam.OamProfileRef" + creation-time: + type: "string" + description: "none" + oam-job-type: + type: "string" + description: "none" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamServicePointRef" + current-data: + type: "array" + description: "Granularity period of the CurrentData identifies the specific\ + \ CurrentData instance in the scope of this OamJob.\r\n \ + \ For example, typically at least\r\n one 15min and\r\n\ + \ one 24hr;\r\n optionally one additional\ + \ configurable (< 15min)" + items: + $ref: "#/definitions/tapi.oam.oamjob.CurrentData" + description: "none" + tapi.oam.oamcontext.OamService: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.eth.OamServiceAugmentation1" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.oamservice.OamServicePoint" + meg: + description: "none" + $ref: "#/definitions/tapi.oam.MegRef" + description: "none" + tapi.oam.oamjob.CurrentData: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation1" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation10" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation11" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation12" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation13" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation14" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation15" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation2" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation3" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation4" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation5" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation6" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation7" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation8" + - $ref: "#/definitions/tapi.eth.CurrentDataAugmentation9" + - type: "object" + properties: + elapsed-time: + description: "none" + $ref: "#/definitions/tapi.common.TimeInterval" + period-start-time: + type: "string" + description: "This attribute indicates the start of the current monitoring\ + \ interval.\r\n The value is bound to the quarter of an\ + \ hour in case of a 15 minute interval and bound to the hour in case of\ + \ a 24 hour interval." + pm-data-pac: + description: "none" + $ref: "#/definitions/tapi.oam.PmDataPac" + history-data: + type: "array" + description: "in case of 24hr Current Data, at least 1 History Data.\r\n\ + \ In case of 15min Current Data, at least 16 History Data.\r\ + \n In case of <15min, the number of History Data shall\ + \ be able to cover a span of 4 hours." + items: + $ref: "#/definitions/tapi.oam.currentdata.HistoryData" + description: "Granularity period of the CurrentData identifies the specific\ + \ CurrentData instance in the scope of this OamJob.\r\n For\ + \ example, typically at least\r\n one 15min and\r\n \ + \ one 24hr;\r\n optionally one additional configurable\ + \ (< 15min)" + tapi.oam.oamservice.OamServicePoint: + allOf: + - $ref: "#/definitions/tapi.eth.OamServicePointAugmentation1" + - $ref: "#/definitions/tapi.eth.OamServicePointAugmentation2" + - $ref: "#/definitions/tapi.oam.OamServicePoint" + tapi.oam.updateoamjob.Input: + allOf: + - $ref: "#/definitions/tapi.eth.InputAugmentation1" + - $ref: "#/definitions/tapi.eth.InputAugmentation2" + - $ref: "#/definitions/tapi.eth.InputAugmentation3" + - $ref: "#/definitions/tapi.eth.InputAugmentation4" + - $ref: "#/definitions/tapi.eth.InputAugmentation5" + - $ref: "#/definitions/tapi.eth.InputAugmentation6" + - $ref: "#/definitions/tapi.eth.InputAugmentation7" + - type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but\ + \ may change during the life of the entity.\r\n A name\ + \ carries no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + schedule: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + oam-profile-id: + type: "string" + description: "UUID of the OamProfile to be applied: An identifier that is\ + \ universally unique within an identifier space, where the identifier\ + \ space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose or state\ + \ of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase\ + \ characters.\r\n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of\ + \ a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the\ + \ purpose or state of the entity.\r\n UUID here uses\ + \ string representation as defined in RFC 4122. The canonical representation\ + \ uses lowercase characters.\r\n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of\ + \ a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + description: "" + tapi.oam.updateoamjob.Output: + type: "object" + properties: + oam-job: + description: "none" + $ref: "#/definitions/tapi.oam.getoamjob.output.OamJob" + tapi.oam.updateoamprofile.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + pm-threshold-data: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.PmThresholdData" + tapi.oam.updateoamprofile.Output: + type: "object" + properties: + oam-profile: + description: "none" + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.updateoamservice.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.createoamservice.input.OamServicePoint" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.updateoamservice.Output: + type: "object" + properties: + oam-service: + description: "none" + $ref: "#/definitions/tapi.oam.updateoamservice.output.OamService" + tapi.oam.updateoamservice.output.OamService: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.eth.OamServiceAugmentation1" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.oamservice.OamServicePoint" + meg: + description: "none" + $ref: "#/definitions/tapi.oam.MegRef" + description: "none" + tapi.oam.updateoamservicepoint.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.updateoamservicepoint.Output: + type: "object" + properties: + oam-service-point: + description: "none" + $ref: "#/definitions/tapi.oam.oamservice.OamServicePoint" + 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.PathComputationService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $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" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + optimization-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "none" + tapi.path.computation.PathObjectiveFunction: + allOf: + - $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.PathOptimizationConstraint: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + traffic-interruption: + description: "none" + $ref: "#/definitions/tapi.common.DirectiveValue" + description: "none" + 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.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.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 + tolerable-impact: + type: "string" + description: "Grades of maximum tolerable disruption to traffic." + 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" + 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" + tapi.path.computation.TopologyConstraint: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + include-node: + type: "string" + description: "This is a loose constraint - that is it is unordered and could\ + \ be a partial list" + exclude-link: + type: "string" + description: "none" + avoid-topology: + type: "string" + description: "none" + exclude-path: + type: "string" + description: "none" + include-topology: + type: "string" + description: "none" + include-path: + type: "string" + description: "none" + exclude-node-edge-point: + type: "string" + description: "none" + include-node-edge-point: + type: "string" + description: "none" + include-link: + type: "string" + description: "This is a loose constraint - that is it is unordered and could\ + \ be a partial list " + preferred-transport-layer: + description: "soft constraint requested by client to indicate the layer(s)\ + \ of transport connection that it prefers to carry the service. This could\ + \ be same as the service layer or one of the supported server layers" + $ref: "#/definitions/tapi.common.LayerProtocolName" + exclude-node: + type: "string" + description: "none" + constraint-weight: + type: "integer" + format: "int32" + description: "Zero and positive values: zero means 'strongly required to\ + \ be included', +1 means 'less strongly required to be included', etc.\r\ + \n For example the work/intended route will be calculated\ + \ considering the topologies which weights are lowest (but not negative).\r\ + \n Negative values: -1 means 'strongly required to be excluded',\ + \ -2 means 'less strongly required to be excluded', etc." + description: "The TopologyConstraint allows to specify topology entities in\ + \ order to impose specific constraints (as denoted by the attribute name)\ + \ on Connectivity/Path.\r\n The topology entities are specified\ + \ by their instance uuid rather than using references/path (to allow for mapping\ + \ to Yang 1.0).\r\n This loose typing and reference necessitates\ + \ that implementations validate not only the presence of the instance, but\ + \ also that it is of the correct type as implied by the attribute name.\r\n\ + \ If this validation fails, then the implementation is expceted\ + \ to return an error.\r\n " + tapi.path.computation.computep2ppath.Input: + type: "object" + properties: + topology-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + objective-function: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.path.computation.computep2ppath.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathComputationService" + tapi.path.computation.deletep2ppath.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.path.computation.deletep2ppath.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathComputationService" + tapi.path.computation.optimizep2ppath.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + optimization-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + objective-function: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + tapi.path.computation.optimizep2ppath.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathComputationService" + tapi.topology.ContextAugmentation5: + type: "object" + properties: + topology-context: + description: "Augments the base TAPI Context with TopologyService information" + $ref: "#/definitions/tapi.topology.TopologyContext" + x-augmentation: + prefix: "tapi-topology" + namespace: "urn:onf:otcc:yang:tapi-topology" + tapi.topology.CostCharacteristic: + type: "object" + properties: + cost-value: + type: "string" + description: "The specific cost." + cost-algorithm: + type: "string" + description: "The cost may vary based upon some properties of the TopologicalEntity.\ + \ The rules for the variation are conveyed by the costAlgorithm." + cost-name: + type: "string" + description: "The cost characteristic will related to some aspect of the TopologicalEntity\ + \ (e.g. $ cost, routing weight). This aspect will be conveyed by the costName." + tapi.topology.ForwardingRule: + type: "string" + enum: + - "MAY_FORWARD_ACROSS_GROUP" + - "MUST_FORWARD_ACROSS_GROUP" + - "CANNOT_FORWARD_ACROSS_GROUP" + - "NO_STATEMENT_ON_FORWARDING" + tapi.topology.GetLinkDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getlinkdetails.Output" + tapi.topology.GetNodeDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getnodedetails.Output" + tapi.topology.GetNodeEdgePointDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Output" + tapi.topology.GetTopologyDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.gettopologydetails.Output" + tapi.topology.GetTopologyList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.gettopologylist.Output" + tapi.topology.InterRuleGroup: + allOf: + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + associated-node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + rule: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Rule" + description: "none" + tapi.topology.LatencyCharacteristic: + type: "object" + properties: + traffic-property-name: + type: "string" + description: "The identifier of the specific traffic property to which the\ + \ queuing latency applies." + jitter-characteristic: + type: "string" + description: "High frequency deviation from true periodicity of a signal and\ + \ therefore a small high rate of change of transfer latency.\r\n \ + \ Applies to TDM systems (and not packet)." + fixed-latency-characteristic: + type: "string" + description: "A TopologicalEntity suffers delay caused by the realization\ + \ of the servers (e.g. distance related; FEC encoding etc.) along with some\ + \ client specific processing. This is the total average latency effect of\ + \ the TopologicalEntity" + wander-characteristic: + type: "string" + description: "Low frequency deviation from true periodicity of a signal and\ + \ therefore a small low rate of change of transfer latency.\r\n \ + \ Applies to TDM systems (and not packet)." + queing-latency-characteristic: + type: "string" + description: "The specific queuing latency for the traffic property." + tapi.topology.LayerProtocolTransitionPac: + type: "object" + properties: + transitioned-layer-protocol-name: + type: "array" + description: "Provides the ordered structure of layer protocol transitions\ + \ encapsulated in the TopologicalEntity. The ordering relates to the LinkPort\ + \ role." + items: + type: "string" + tapi.topology.Link: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.LayerProtocolTransitionPac" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - $ref: "#/definitions/tapi.topology.ValidationPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + restoration-policy: + description: "none" + $ref: "#/definitions/tapi.topology.RestorationPolicy" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" + direction: + description: "The directionality of the Link. \r\n Is applicable\ + \ to simple Links where all LinkEnds are BIDIRECTIONAL (the Link will\ + \ be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ + \ \r\n Is not present in more complex cases." + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "The Link object class models effective adjacency between two or\ + \ more ForwardingDomains (FD). " + tapi.topology.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.NepLayerProtocolCapability: + type: "object" + properties: + layer-protocol-qualifier: + type: "string" + description: "none" + number-of-cep-instances: + type: "integer" + format: "int32" + description: "none" + tapi.topology.NetworkTopologyService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.TopologyRef" + description: "none" + tapi.topology.Node: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + encap-topology: + description: "none" + $ref: "#/definitions/tapi.topology.TopologyRef" + node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePoint" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ + \ topological component which is used to effect forwarding of transport characteristic\ + \ information and offers the potential to enable forwarding. \r\n \ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ multiple switch matrices (FDs). " + tapi.topology.NodeEdgePoint: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.common.TerminationPac" + - type: "object" + properties: + link-port-role: + description: "Each LinkEnd of the Link has a role (e.g., symmetric, hub,\ + \ spoke, leaf, root) in the context of the Link with respect to the Link\ + \ function. " + $ref: "#/definitions/tapi.common.PortRole" + mapped-service-interface-point: + type: "array" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load\ + \ balancing/Resilience) should be considered experimental" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + available-cep-layer-protocol: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + link-port-direction: + description: "The orientation of defined flow at the LinkEnd." + $ref: "#/definitions/tapi.common.PortDirection" + description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ + \ termination and adaptation functions of one or more transport layers. \r\ + \n The structure of LTP supports all transport protocols including\ + \ circuit and packet forms." + tapi.topology.NodeEdgePointRef: + allOf: + - $ref: "#/definitions/tapi.topology.NodeRef" + - type: "object" + properties: + node-edge-point-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-edge-point/tapi-topology:uuid" + description: "none" + tapi.topology.NodeRef: + allOf: + - $ref: "#/definitions/tapi.topology.TopologyRef" + - type: "object" + properties: + node-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:uuid" + description: "none" + tapi.topology.NodeRuleGroup: + allOf: + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + inter-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.InterRuleGroup" + rule: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Rule" + composed-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "none" + tapi.topology.NodeRuleGroupRef: + allOf: + - $ref: "#/definitions/tapi.topology.NodeRef" + - type: "object" + properties: + node-rule-group-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-rule-group/tapi-topology:uuid" + description: "none" + tapi.topology.ProtectionType: + type: "string" + enum: + - "NO_PROTECTION" + - "ONE_PLUS_ONE_PROTECTION" + - "ONE_FOR_ONE_PROTECTION" + - "ONE_FOR_N_PROTECTION" + - "M_FOR_N_PROTECTION" + - "ONE_FOR_ONE_BY_N" + tapi.topology.RestorationPolicy: + type: "string" + enum: + - "PER_DOMAIN_RESTORATION" + - "END_TO_END_RESTORATION" + - "NA" + - "DYNAMIC_RESTORATION" + - "PRE_COMPUTED_RESTORATION" + tapi.topology.RiskCharacteristic: + type: "object" + properties: + risk-characteristic-name: + type: "string" + description: "The name of the risk characteristic. The characteristic may\ + \ be related to a specific degree of closeness. \r\n For\ + \ example a particular characteristic may apply to failures that are localized\ + \ (e.g. to one side of a road) where as another characteristic may relate\ + \ to failures that have a broader impact (e.g. both sides of a road that\ + \ crosses a bridge).\r\n Depending upon the importance of\ + \ the traffic being routed different risk characteristics will be evaluated." + risk-identifier-list: + type: "array" + description: "A list of the identifiers of each physical/geographic unit (with\ + \ the specific risk characteristic) that is related to a segment of the\ + \ TopologicalEntity." + items: + type: "string" + tapi.topology.RiskParameterPac: + type: "object" + properties: + risk-characteristic: + type: "array" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + items: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + tapi.topology.Rule: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + override-priority: + type: "integer" + format: "int32" + description: "none" + forwarding-rule: + description: "none" + $ref: "#/definitions/tapi.topology.ForwardingRule" + rule-type: + description: "none" + $ref: "#/definitions/tapi.topology.RuleType" + description: "none" + tapi.topology.RuleType: + type: "string" + enum: + - "FORWARDING" + - "CAPACITY" + - "COST" + - "TIMING" + - "RISK" + - "GROUPING" + tapi.topology.Topology: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + link: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Link" + node: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Node" + boundary-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ + \ topological component which is used to effect forwarding of transport characteristic\ + \ information and offers the potential to enable forwarding. \r\n \ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ multiple switch matrices (FDs). " + tapi.topology.TopologyContext: + type: "object" + properties: + nw-topology-service: + description: "none" + $ref: "#/definitions/tapi.topology.NetworkTopologyService" + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.TopologyRef: + type: "object" + properties: + topology-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:uuid" + tapi.topology.TransferCostPac: + type: "object" + properties: + cost-characteristic: + type: "array" + description: "The list of costs where each cost relates to some aspect of\ + \ the TopologicalEntity." + items: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + tapi.topology.TransferIntegrityPac: + type: "object" + properties: + error-characteristic: + type: "string" + description: "Describes the degree to which the signal propagated can be errored.\ + \ \r\n Applies to TDM systems as the errored signal will\ + \ be propagated and not packet as errored packets will be discarded." + unavailable-time-characteristic: + type: "string" + description: "Describes the duration for which there may be no valid signal\ + \ propagated." + server-integrity-process-characteristic: + type: "string" + description: "Describes the effect of any server integrity enhancement process\ + \ on the characteristics of the TopologicalEntity." + delivery-order-characteristic: + type: "string" + description: "Describes the degree to which packets will be delivered out\ + \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ + \ maintain strict order." + repeat-delivery-characteristic: + type: "string" + description: "Primarily applies to packet systems where a packet may be delivered\ + \ more than once (in fault recovery for example). \r\n It\ + \ can also apply to TDM where several frames may be received twice due to\ + \ switching in a system with a large differential propagation delay." + loss-characteristic: + type: "string" + description: "Describes the acceptable characteristic of lost packets where\ + \ loss may result from discard due to errors or overflow.\r\n \ + \ Applies to packet systems and not TDM (as for TDM errored signals\ + \ are propagated unless grossly errored and overflow/underflow turns into\ + \ timing slips)." + tapi.topology.TransferTimingPac: + type: "object" + properties: + latency-characteristic: + type: "array" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + items: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + tapi.topology.ValidationMechanism: + type: "object" + properties: + layer-protocol-adjacency-validated: + type: "string" + description: "State of validatiion" + validation-mechanism: + type: "string" + description: "Name of mechanism used to validate adjacency" + validation-robustness: + type: "string" + description: "Quality of validation (i.e. how likely is the stated validation\ + \ to be invalid)" + tapi.topology.ValidationPac: + type: "object" + properties: + validation-mechanism: + type: "array" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." + items: + $ref: "#/definitions/tapi.topology.ValidationMechanism" + tapi.topology.getlinkdetails.Input: + type: "object" + properties: + link-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getlinkdetails.Output: + type: "object" + properties: + link: + description: "none" + $ref: "#/definitions/tapi.topology.Link" + tapi.topology.getnodedetails.Input: + type: "object" + properties: + node-id: + type: "string" + description: "UUID of the Node: An identifier that is universally unique within\ + \ an identifier space, where the identifier space is itself globally unique,\ + \ and immutable.\r\n An UUID carries no semantics with\ + \ respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The canonical\ + \ representation uses lowercase characters.\r\n Pattern:\ + \ [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getnodedetails.Output: + type: "object" + properties: + node: + description: "none" + $ref: "#/definitions/tapi.topology.Node" + tapi.topology.getnodeedgepointdetails.Input: + type: "object" + properties: + node-id: + type: "string" + description: "UUID of the parent Node: An identifier that is universally unique\ + \ within an identifier space, where the identifier space is itself globally\ + \ unique, and immutable.\r\n An UUID carries no semantics\ + \ with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The\ + \ canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Node's Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + node-edge-point-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getnodeedgepointdetails.Output: + type: "object" + properties: + node-edge-point: + description: "none" + $ref: "#/definitions/tapi.topology.NodeEdgePoint" + tapi.topology.gettopologydetails.Input: + type: "object" + properties: + topology-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.gettopologydetails.Output: + type: "object" + properties: + topology: + description: "none" + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.gettopologylist.Output: + type: "object" + properties: + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.node.NodeEdgePoint: + allOf: + - $ref: "#/definitions/tapi.connectivity.NodeEdgePointAugmentation1" + - $ref: "#/definitions/tapi.topology.NodeEdgePoint" + tapi.topology.topology.Node: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + encap-topology: + description: "none" + $ref: "#/definitions/tapi.topology.TopologyRef" + node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.node.NodeEdgePoint" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "none" diff --git a/OAS/tapi-notification@2019-03-31.yaml b/OAS/tapi-notification@2019-03-31.yaml new file mode 100644 index 00000000..0e3c6545 --- /dev/null +++ b/OAS/tapi-notification@2019-03-31.yaml @@ -0,0 +1,1967 @@ +--- +swagger: "2.0" +info: + description: "\r\n This module contains TAPI Notification Model definitions.\r\ + \n Source: TapiNotification.uml\r\n Copyright (c) 2018 Open Networking\ + \ Foundation (ONF). All rights reserved.\r\n License: This module is distributed\ + \ under the Apache License 2.0\r\n - The TAPI YANG models included in this\ + \ TAPI release are a *normative* part of the TAPI SDK.\r\n - The YANG specifications\ + \ have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG\ + \ mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Common Model\ + \ definitions.\r\n Source: TapiCommon.uml\r\n Copyright (c) 2018\ + \ Open Networking Foundation (ONF). All rights reserved.\r\n License: This\ + \ module is distributed under the Apache License 2.0\r\n - The TAPI YANG\ + \ models included in this TAPI release are a *normative* part of the TAPI SDK.\r\ + \n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases." + version: "2.2.0" + title: "tapi-notification,tapi-common API" +host: "localhost:1234" +consumes: +- "application/yang-data+json" +produces: +- "application/yang-data+json" +paths: + /data/context/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Context" + description: "none" + parameters: [] + responses: + 200: + description: "tapi.common.Context" + schema: + $ref: "#/definitions/tapi.common.Context" + 400: + description: "Internal error" + post: + tags: + - "tapi-common" + summary: "creates tapi.common.Context" + description: "none" + parameters: + - in: "body" + name: "tapi.common.Context.body-param" + description: "tapi.common.Context to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.Context" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.Context" + description: "none" + parameters: + - in: "body" + name: "tapi.common.Context.body-param" + description: "tapi.common.Context to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.Context" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.Context" + description: "none" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/name/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] + responses: + 200: + description: "tapi.notification.NotificationContext" + schema: + $ref: "#/definitions/tapi.notification.NotificationContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: + - in: "body" + name: "tapi.notification.NotificationContext.body-param" + description: "tapi.notification.NotificationContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: + - in: "body" + name: "tapi.notification.NotificationContext.body-param" + description: "tapi.notification.NotificationContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - in: "body" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NotificationSubscriptionService" + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/name/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/notification-channel/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationChannel" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NotificationChannel" + schema: + $ref: "#/definitions/tapi.notification.NotificationChannel" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.Notification" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.Notification" + schema: + $ref: "#/definitions/tapi.notification.Notification" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.SubscriptionFilter" + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + 400: + description: "Internal error" + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notification={uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.Notification" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.Notification" + schema: + $ref: "#/definitions/tapi.notification.Notification" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/additional-info={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/service-interface-point/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - in: "body" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/service-interface-point={uuid}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePoint" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/available-capacity/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/name/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/service-interface-point={uuid}/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/total-potential-capacity/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /operations/create-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.CreateNotificationSubscriptionService" + description: "operates on tapi.notification.CreateNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.CreateNotificationSubscriptionService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.DeleteNotificationSubscriptionService" + description: "operates on tapi.notification.DeleteNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.deletenotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-list/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationList" + description: "operates on tapi.notification.GetNotificationList" + parameters: + - in: "body" + name: "tapi.notification.getnotificationlist.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.getnotificationlist.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-subscription-service-details/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + description: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + parameters: + - in: "body" + name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-subscription-service-list/: + post: + tags: + - "tapi-notification" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-service-interface-point-details/: + post: + tags: + - "tapi-common" + summary: "operates on tapi.common.GetServiceInterfacePointDetails" + description: "operates on tapi.common.GetServiceInterfacePointDetails" + parameters: + - in: "body" + name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.common.GetServiceInterfacePointDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-service-interface-point-list/: + post: + tags: + - "tapi-common" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.common.GetServiceInterfacePointList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-supported-notification-types/: + post: + tags: + - "tapi-notification" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetSupportedNotificationTypes" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.UpdateNotificationSubscriptionService" + description: "operates on tapi.notification.UpdateNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.UpdateNotificationSubscriptionService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-service-interface-point/: + post: + tags: + - "tapi-common" + summary: "operates on tapi.common.UpdateServiceInterfacePoint" + description: "operates on tapi.common.UpdateServiceInterfacePoint" + parameters: + - in: "body" + name: "tapi.common.updateserviceinterfacepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.common.updateserviceinterfacepoint.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" +definitions: + tapi.common.AdminStatePac: + type: "object" + properties: + operational-state: + description: "none" + $ref: "#/definitions/tapi.common.OperationalState" + lifecycle-state: + description: "none" + $ref: "#/definitions/tapi.common.LifecycleState" + administrative-state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + tapi.common.AdministrativeState: + type: "string" + enum: + - "LOCKED" + - "UNLOCKED" + tapi.common.Capacity: + type: "object" + properties: + total-size: + description: "Total capacity of the TopologicalEntity in MB/s. In case of\ + \ bandwidthProfile, this is expected to same as the committedInformationRate." + $ref: "#/definitions/tapi.common.CapacityValue" + tapi.common.CapacityPac: + type: "object" + properties: + available-capacity: + description: "Capacity available to be assigned." + $ref: "#/definitions/tapi.common.Capacity" + total-potential-capacity: + description: "An optimistic view of the capacity of the TopologicalEntity\ + \ assuming that any shared capacity is available to be taken." + $ref: "#/definitions/tapi.common.Capacity" + tapi.common.CapacityUnit: + type: "string" + enum: + - "TB" + - "TBPS" + - "GB" + - "GBPS" + - "MB" + - "MBPS" + - "KB" + - "KBPS" + - "GHz" + - "MHz" + tapi.common.CapacityValue: + type: "object" + properties: + value: + type: "integer" + format: "int32" + description: "none" + unit: + description: "none" + $ref: "#/definitions/tapi.common.CapacityUnit" + tapi.common.Context: + allOf: + - $ref: "#/definitions/tapi.common.TapiContext" + - $ref: "#/definitions/tapi.notification.ContextAugmentation1" + tapi.common.GetServiceInterfacePointDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Output" + tapi.common.GetServiceInterfacePointList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.common.getserviceinterfacepointlist.Output" + tapi.common.GlobalClass: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a UUID\ + \ in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.common.LayerProtocolName: + type: "string" + enum: + - "ODU" + - "ETH" + - "DSR" + - "PHOTONIC_MEDIA" + tapi.common.LifecycleState: + type: "string" + enum: + - "PLANNED" + - "POTENTIAL_AVAILABLE" + - "POTENTIAL_BUSY" + - "INSTALLED" + - "PENDING_REMOVAL" + tapi.common.LocalClass: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + local-id: + type: "string" + description: "none" + tapi.common.NameAndValue: + type: "object" + properties: + value-name: + type: "string" + description: "The name of the value. The value need not have a name." + value: + type: "string" + description: "The value" + tapi.common.OperationalState: + type: "string" + enum: + - "DISABLED" + - "ENABLED" + tapi.common.ServiceInterfacePoint: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + supported-layer-protocol-qualifier: + type: "array" + description: "none" + items: + type: "string" + layer-protocol-name: + description: "Usage of layerProtocolName [>1] in the ServiceInterfacePoint\ + \ should be considered experimental" + $ref: "#/definitions/tapi.common.LayerProtocolName" + description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ + \ termination and adaptation functions of one or more transport layers. \r\ + \n The structure of LTP supports all transport protocols including\ + \ circuit and packet forms." + tapi.common.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.TimeRange: + type: "object" + properties: + end-time: + type: "string" + description: "none" + start-time: + type: "string" + description: "none" + tapi.common.getserviceinterfacepointdetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.common.getserviceinterfacepointdetails.Output: + type: "object" + properties: + sip: + description: "none" + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + tapi.common.getserviceinterfacepointlist.Output: + type: "object" + properties: + sip: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + tapi.common.updateserviceinterfacepoint.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + tapi.notification.ContextAugmentation1: + type: "object" + properties: + notification-context: + description: "Augments the base TAPI Context with NotificationService information" + $ref: "#/definitions/tapi.notification.NotificationContext" + x-augmentation: + prefix: "tapi-notification" + namespace: "urn:onf:otcc:yang:tapi-notification" + tapi.notification.CreateNotificationSubscriptionService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Output" + tapi.notification.GetNotificationList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationlist.Output" + tapi.notification.GetNotificationSubscriptionServiceDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Output" + tapi.notification.GetNotificationSubscriptionServiceList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicelist.Output" + tapi.notification.GetSupportedNotificationTypes: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getsupportednotificationtypes.Output" + tapi.notification.NameAndValueChange: + type: "object" + properties: + value-name: + type: "string" + description: "The name of the value. The value need not have a name." + old-value: + type: "string" + description: "The value" + new-value: + type: "string" + description: "The value" + tapi.notification.Notification: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + target-object-type: + type: "string" + description: "none" + additional-text: + type: "string" + description: "none" + event-time-stamp: + type: "string" + description: "none" + additional-info: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.NameAndValue" + sequence-number: + type: "integer" + format: "int32" + description: "A monotonous increasing sequence number associated with the\ + \ notification.\r\n The exact semantics of how this sequence\ + \ number is assigned (per channel or subscription or source or system)\ + \ is left undefined." + target-object-identifier: + type: "string" + description: "none" + notification-type: + type: "string" + description: "none" + target-object-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.NameAndValue" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + source-indicator: + description: "none" + $ref: "#/definitions/tapi.notification.SourceIndicator" + layer-protocol-qualifier: + type: "string" + description: "none" + changed-attributes: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + description: "none" + tapi.notification.NotificationChannel: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + next-sequence-no: + type: "integer" + format: "int32" + description: "The sequence number of the next notification that will be\ + \ published on the channel" + stream-address: + type: "string" + description: "The address/location/URI of the channel/stream to which the\ + \ subscribed notifications are published.\r\n This specifics\ + \ of this is typically dependent on the implementation protocol & mechanism\ + \ and hence is typed as a string." + description: "none" + tapi.notification.NotificationContext: + type: "object" + properties: + notif-subscription: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.Notification" + tapi.notification.NotificationSubscriptionService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.Notification" + notification-channel: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationChannel" + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + supported-object-types: + type: "array" + description: "none" + items: + type: "string" + supported-notification-types: + type: "array" + description: "none" + items: + type: "string" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + description: "none" + tapi.notification.SourceIndicator: + type: "string" + enum: + - "RESOURCE_OPERATION" + - "MANAGEMENT_OPERATION" + - "UNKNOWN" + tapi.notification.SubscriptionFilter: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + requested-notification-types: + type: "array" + description: "none" + items: + type: "string" + requested-object-identifier: + type: "array" + description: "none" + items: + type: "string" + requested-layer-protocols: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + include-content: + type: "boolean" + description: "Indicates whether the published Notification includes content\ + \ or just the Notification Id (which enables retrieval of the notification\ + \ at the later stage)" + default: false + requested-object-types: + type: "array" + description: "none" + items: + type: "string" + description: "none" + tapi.notification.SubscriptionState: + type: "string" + enum: + - "SUSPENDED" + - "ACTIVE" + tapi.notification.UpdateNotificationSubscriptionService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Output" + tapi.notification.createnotificationsubscriptionservice.Input: + type: "object" + properties: + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + tapi.notification.createnotificationsubscriptionservice.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.deletenotificationsubscriptionservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationlist.Input: + type: "object" + properties: + time-range: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + subscription-id: + type: "string" + description: "UUID of the associated Notification Subscription Service: An\ + \ identifier that is universally unique within an identifier space, where\ + \ the identifier space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationlist.Output: + type: "object" + properties: + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.Notification" + tapi.notification.getnotificationsubscriptionservicedetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationsubscriptionservicedetails.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.getnotificationsubscriptionservicelist.Output: + type: "object" + properties: + subscription-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.getsupportednotificationtypes.Output: + type: "object" + properties: + supported-object-types: + type: "array" + description: "none" + items: + type: "string" + supported-notification-types: + type: "array" + description: "none" + items: + type: "string" + tapi.notification.updatenotificationsubscriptionservice.Input: + type: "object" + properties: + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + tapi.notification.updatenotificationsubscriptionservice.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" diff --git a/OAS/tapi-oam@2019-03-31.yaml b/OAS/tapi-oam@2019-03-31.yaml new file mode 100644 index 00000000..da05ae98 --- /dev/null +++ b/OAS/tapi-oam@2019-03-31.yaml @@ -0,0 +1,15800 @@ +--- +swagger: "2.0" +info: + description: "\r\n This module contains TAPI Notification Model definitions.\r\ + \n Source: TapiNotification.uml\r\n Copyright (c) 2018 Open Networking\ + \ Foundation (ONF). All rights reserved.\r\n License: This module is distributed\ + \ under the Apache License 2.0\r\n - The TAPI YANG models included in this\ + \ TAPI release are a *normative* part of the TAPI SDK.\r\n - The YANG specifications\ + \ have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG\ + \ mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Topology\ + \ Model definitions.\r\n Source: TapiTopology.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Common Model\ + \ definitions.\r\n Source: TapiCommon.uml\r\n Copyright (c) 2018\ + \ Open Networking Foundation (ONF). All rights reserved.\r\n License: This\ + \ module is distributed under the Apache License 2.0\r\n - The TAPI YANG\ + \ models included in this TAPI release are a *normative* part of the TAPI SDK.\r\ + \n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Path Computation\ + \ Model definitions.\r\n Source: TapiPathComputation.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Connectivity\ + \ Model definitions.\r\n Source: TapiConnectivity.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI OAM Model\ + \ definitions.\r\n Source: TapiOam.uml\r\n Copyright (c) 2018 Open\ + \ Networking Foundation (ONF). All rights reserved.\r\n License: This module\ + \ is distributed under the Apache License 2.0\r\n - The TAPI YANG models\ + \ included in this TAPI release are a *normative* part of the TAPI SDK.\r\n \ + \ - The YANG specifications have been generated from the corresponding UML\ + \ model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases." + version: "2.2.0" + title: "tapi-notification,tapi-topology,tapi-common,tapi-path-computation,tapi-connectivity,tapi-oam\ + \ API" +host: "localhost:1234" +consumes: +- "application/yang-data+json" +produces: +- "application/yang-data+json" +paths: + /data/context/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Context" + description: "none" + parameters: [] + responses: + 200: + description: "tapi.common.Context" + schema: + $ref: "#/definitions/tapi.common.Context" + 400: + description: "Internal error" + post: + tags: + - "tapi-common" + summary: "creates tapi.common.Context" + description: "none" + parameters: + - in: "body" + name: "tapi.common.Context.body-param" + description: "tapi.common.Context to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.Context" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.Context" + description: "none" + parameters: + - in: "body" + name: "tapi.common.Context.body-param" + description: "tapi.common.Context to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.Context" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.Context" + description: "none" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/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.ConnectivityContext" + 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.ConnectivityContext" + 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.ConnectivityContext" + 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/context/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.Connection" + 400: + description: "Internal error" + /data/context/connectivity-context/connection={uuid}/bounding-node/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.topology.NodeRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connection" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRef" + 400: + description: "Internal error" + ? /data/context/connectivity-context/connection={uuid}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ + : get: + tags: + - "tapi-connectivity" + 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.ConnectionEndPointRef" + 400: + description: "Internal error" + /data/context/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.ConnectionRef" + 400: + description: "Internal error" + /data/context/connectivity-context/connection={uuid}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of 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.NameAndValue" + 400: + description: "Internal error" + /data/context/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.Route" + 400: + description: "Internal error" + ? /data/context/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.ConnectionEndPointRef" + 400: + description: "Internal error" + /data/context/connectivity-context/connection={uuid}/route={local-id}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of 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.NameAndValue" + 400: + description: "Internal error" + /data/context/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.LinkRef" + 400: + description: "Internal error" + /data/context/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.SwitchControl" + 400: + description: "Internal error" + /data/context/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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n 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.NameAndValue" + 400: + description: "Internal error" + ? /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/sub-switch-control={connection-uuid},{sub-switch-control-switch-control-uuid}/ + : get: + tags: + - "tapi-connectivity" + 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.SwitchControlRef" + 400: + description: "Internal error" + /data/context/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.Switch" + 400: + description: "Internal error" + /data/context/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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n 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.NameAndValue" + 400: + description: "Internal error" + ? /data/context/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.ConnectionEndPointRef" + 400: + description: "Internal error" + ? /data/context/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.RouteRef" + 400: + description: "Internal error" + /data/context/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.ConnectivityService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/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.ConnectivityService" + 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.ConnectivityService" + 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/context/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.ConnectionRef" + 400: + description: "Internal error" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.ConnectivityConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.ConnectivityConstraint" + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.connectivity.ConnectivityConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ConnectivityConstraint.body-param" + description: "tapi.connectivity.ConnectivityConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.connectivity.ConnectivityConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ConnectivityConstraint.body-param" + description: "tapi.connectivity.ConnectivityConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.connectivity.ConnectivityConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.ConnectivityServiceRef" + 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.ConnectivityServiceRef" + 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.ConnectivityServiceRef" + 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/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.ConnectivityServiceRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.ConnectivityServiceRef" + 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.ConnectivityServiceRef" + 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/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.Capacity" + 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.Capacity" + 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.Capacity" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.CapacityValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-connectivity" + 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.CapacityValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.TimeRange" + 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.TimeRange" + 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.TimeRange" + 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/context/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.ConnectivityServiceEndPoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/: + 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.ConnectivityServiceEndPoint" + 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.ConnectivityServiceEndPoint" + 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/context/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.Capacity" + 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.Capacity" + 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.Capacity" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/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.CapacityValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-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.CapacityValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/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.ConnectionEndPointRef" + 400: + description: "Internal error" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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/context/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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/server-connectivity-service-end-point/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of 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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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/context/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.ServiceInterfacePointRef" + 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.ServiceInterfacePointRef" + 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.ServiceInterfacePointRef" + 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/context/connectivity-context/connectivity-service={uuid}/name/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/resilience-constraint/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.ResilienceConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.ResilienceConstraint" + schema: + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.connectivity.ResilienceConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ResilienceConstraint.body-param" + description: "tapi.connectivity.ResilienceConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.connectivity.ResilienceConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ResilienceConstraint.body-param" + description: "tapi.connectivity.ResilienceConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.connectivity.ResilienceConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.RoutingConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/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.CostCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + 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.CostCharacteristic" + 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/context/connectivity-context/connectivity-service={uuid}/routing-constraint/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.LatencyCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-connectivity" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + 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.LatencyCharacteristic" + 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/context/connectivity-context/connectivity-service={uuid}/routing-constraint/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.RiskCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/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.RiskCharacteristic" + 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.RiskCharacteristic" + 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/context/connectivity-context/connectivity-service={uuid}/topology-constraint/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.path.computation.TopologyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.path.computation.TopologyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.TopologyConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.path.computation.TopologyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.path.computation.TopologyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/name/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/name/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] + responses: + 200: + description: "tapi.notification.context.NotificationContext" + schema: + $ref: "#/definitions/tapi.notification.context.NotificationContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: + - in: "body" + name: "tapi.notification.context.NotificationContext.body-param" + description: "tapi.notification.context.NotificationContext to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.notification.context.NotificationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: + - in: "body" + name: "tapi.notification.context.NotificationContext.body-param" + description: "tapi.notification.context.NotificationContext to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.context.NotificationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - in: "body" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NotificationSubscriptionService" + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/name/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/notification-channel/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationChannel" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NotificationChannel" + schema: + $ref: "#/definitions/tapi.notification.NotificationChannel" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.Notification" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.Notification" + schema: + $ref: "#/definitions/tapi.notification.Notification" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.SubscriptionFilter" + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + 400: + description: "Internal error" + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notification={uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.notificationcontext.Notification" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.notificationcontext.Notification" + schema: + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/additional-info={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/alarm-info/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.AlarmInfo" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.AlarmInfo" + schema: + $ref: "#/definitions/tapi.oam.AlarmInfo" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.TcaInfo" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.TcaInfo" + schema: + $ref: "#/definitions/tapi.oam.TcaInfo" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/oam-job/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamJobRef" + description: "MEF 35.1\r\n Identification of the PM Session for\ + \ which the TCA Function was configured." + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamJobRef" + schema: + $ref: "#/definitions/tapi.oam.OamJobRef" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.ThresholdParameter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.ThresholdParameter" + schema: + $ref: "#/definitions/tapi.oam.ThresholdParameter" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-above-thrs/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-below-thrs/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-clear-thrs/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + /data/context/oam-context/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: [] + responses: + 200: + description: "tapi.oam.OamContext" + schema: + $ref: "#/definitions/tapi.oam.OamContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: + - in: "body" + name: "tapi.oam.OamContext.body-param" + description: "tapi.oam.OamContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: + - in: "body" + name: "tapi.oam.OamContext.body-param" + description: "tapi.oam.OamContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/meg={uuid}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.Meg" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.Meg" + schema: + $ref: "#/definitions/tapi.oam.Meg" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.Mep" + description: "1. ME may have 0 MEPs (case of transit domains where at least\ + \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case of edge\ + \ domaind, where the peer MEP is ouside the managed domain)\r\n \ + \ 3. ME may have 2 MEPs" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.Mep" + schema: + $ref: "#/definitions/tapi.oam.Mep" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mip={local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.Mip" + description: "ME may 0, 1, or more MIPs" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.Mip" + schema: + $ref: "#/definitions/tapi.oam.Mip" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mip={local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/oam-context/oam-job/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamJob" + description: "none" + parameters: + - in: "body" + name: "tapi.oam.OamJob.body-param" + description: "tapi.oam.OamJob to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamJob" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-job={uuid}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamJob" + schema: + $ref: "#/definitions/tapi.oam.OamJob" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamJob.body-param" + description: "tapi.oam.OamJob to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamJob" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.CurrentData" + description: "Granularity period of the CurrentData identifies the specific\ + \ CurrentData instance in the scope of this OamJob.\r\n For\ + \ example, typically at least\r\n one 15min and\r\n \ + \ one 24hr;\r\n optionally one additional configurable\ + \ (< 15min)" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.CurrentData" + schema: + $ref: "#/definitions/tapi.oam.CurrentData" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/elapsed-time/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimeInterval" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimeInterval" + schema: + $ref: "#/definitions/tapi.common.TimeInterval" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/elapsed-time/period={unit}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "unit" + in: "path" + description: "Id of period" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimePeriod" + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.HistoryData" + description: "in case of 24hr Current Data, at least 1 History Data.\r\n \ + \ In case of 15min Current Data, at least 16 History Data.\r\n\ + \ In case of <15min, the number of History Data shall be able\ + \ to cover a span of 4 hours." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.HistoryData" + schema: + $ref: "#/definitions/tapi.oam.HistoryData" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/pm-data-pac/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmDataPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmDataPac" + schema: + $ref: "#/definitions/tapi.oam.PmDataPac" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/pm-data-pac/granularity-period/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimePeriod" + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/pm-data-pac/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmDataPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmDataPac" + schema: + $ref: "#/definitions/tapi.oam.PmDataPac" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/pm-data-pac/granularity-period/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimePeriod" + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-job={uuid}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/oam-profile/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamProfileRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamProfileRef" + schema: + $ref: "#/definitions/tapi.oam.OamProfileRef" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamProfileRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamProfileRef.body-param" + description: "tapi.oam.OamProfileRef to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfileRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamProfileRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamProfileRef.body-param" + description: "tapi.oam.OamProfileRef to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfileRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamProfileRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamServicePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamServicePointRef.body-param" + description: "tapi.oam.OamServicePointRef to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamServicePointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-job={uuid}/oam-service-point={oam-service-uuid},{oam-service-point-local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamServicePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "oam-service-uuid" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "oam-service-point-local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamServicePointRef" + schema: + $ref: "#/definitions/tapi.oam.OamServicePointRef" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamServicePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "oam-service-uuid" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "oam-service-point-local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamServicePointRef.body-param" + description: "tapi.oam.OamServicePointRef to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamServicePointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamServicePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "oam-service-uuid" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "oam-service-point-local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/schedule/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimeRange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimeRange" + schema: + $ref: "#/definitions/tapi.common.TimeRange" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.TimeRange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.TimeRange" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.TimeRange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.TimeRange" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.TimeRange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamProfile" + description: "none" + parameters: + - in: "body" + name: "tapi.oam.OamProfile.body-param" + description: "tapi.oam.OamProfile to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfile" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamProfile" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamProfile" + schema: + $ref: "#/definitions/tapi.oam.OamProfile" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamProfile" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamProfile.body-param" + description: "tapi.oam.OamProfile to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfile" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamProfile" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.PmThresholdData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmThresholdData.body-param" + description: "tapi.oam.PmThresholdData to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmThresholdData" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmThresholdData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmThresholdData" + schema: + $ref: "#/definitions/tapi.oam.PmThresholdData" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.PmThresholdData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmThresholdData.body-param" + description: "tapi.oam.PmThresholdData to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmThresholdData" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.PmThresholdData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/granularity-period/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimePeriod" + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - in: "body" + name: "tapi.common.TimePeriod.body-param" + description: "tapi.common.TimePeriod to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - in: "body" + name: "tapi.common.TimePeriod.body-param" + description: "tapi.common.TimePeriod to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.ThresholdParameter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - in: "body" + name: "tapi.oam.ThresholdParameter.body-param" + description: "tapi.oam.ThresholdParameter to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.ThresholdParameter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.ThresholdParameter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.ThresholdParameter" + schema: + $ref: "#/definitions/tapi.oam.ThresholdParameter" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.ThresholdParameter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.ThresholdParameter.body-param" + description: "tapi.oam.ThresholdParameter to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.ThresholdParameter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.ThresholdParameter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-above-thrs/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-below-thrs/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-clear-thrs/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamService" + description: "none" + parameters: + - in: "body" + name: "tapi.oam.OamService.body-param" + description: "tapi.oam.OamService to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-service={uuid}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamService" + schema: + $ref: "#/definitions/tapi.oam.OamService" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamService.body-param" + description: "tapi.oam.OamService to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/meg/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MegRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MegRef" + schema: + $ref: "#/definitions/tapi.oam.MegRef" + 400: + description: "Internal error" + /data/context/oam-context/oam-service={uuid}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-service={uuid}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamServicePoint.body-param" + description: "tapi.oam.OamServicePoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamServicePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamServicePoint" + schema: + $ref: "#/definitions/tapi.oam.OamServicePoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamServicePoint.body-param" + description: "tapi.oam.OamServicePoint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamServicePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/connectivity-service-end-point/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.ConnectivityServiceEndPointRef" + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/mep/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MepRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MepRef" + schema: + $ref: "#/definitions/tapi.oam.MepRef" + 400: + description: "Internal error" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/mip/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MipRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MipRef" + schema: + $ref: "#/definitions/tapi.oam.MipRef" + 400: + description: "Internal error" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/service-interface-point/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePointRef" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: [] + responses: + 200: + description: "tapi.path.computation.PathComputationContext" + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: + - in: "body" + name: "tapi.path.computation.PathComputationContext.body-param" + description: "tapi.path.computation.PathComputationContext to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: + - in: "body" + name: "tapi.path.computation.PathComputationContext.body-param" + description: "tapi.path.computation.PathComputationContext to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathComputationService" + description: "none" + parameters: + - in: "body" + name: "tapi.path.computation.PathComputationService.body-param" + description: "tapi.path.computation.PathComputationService to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathComputationService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.PathComputationService" + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationService" + 400: + description: "Internal error" + 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.PathComputationService" + 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/context/path-computation-context/path-comp-service={uuid}/end-point/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathServiceEndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.PathServiceEndPoint.body-param" + description: "tapi.path.computation.PathServiceEndPoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathServiceEndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.PathServiceEndPoint" + schema: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-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.PathServiceEndPoint" + 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/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of 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.Capacity" + 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.Capacity" + 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.Capacity" + 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/context/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.CapacityValue" + 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.CapacityValue" + 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.CapacityValue" + 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/context/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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/service-interface-point/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePointRef" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 400: + description: "Internal error" + post: + tags: + - "tapi-path-computation" + 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.ServiceInterfacePointRef" + 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.ServiceInterfacePointRef" + 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/context/path-computation-context/path-comp-service={uuid}/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/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.PathObjectiveFunction" + 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.PathObjectiveFunction" + 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.PathObjectiveFunction" + 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/context/path-computation-context/path-comp-service={uuid}/objective-function/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/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.PathOptimizationConstraint" + 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.PathOptimizationConstraint" + 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.PathOptimizationConstraint" + 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/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/path={path-uuid}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "path-uuid" + in: "path" + description: "Id of path" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.PathRef" + schema: + $ref: "#/definitions/tapi.path.computation.PathRef" + 400: + description: "Internal error" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.RoutingConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + 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.CostCharacteristic" + 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/context/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.LatencyCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-path-computation" + 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.LatencyCharacteristic" + 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.LatencyCharacteristic" + 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/context/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.RiskCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-path-computation" + 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.RiskCharacteristic" + 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.RiskCharacteristic" + 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/context/path-computation-context/path-comp-service={uuid}/topology-constraint/: + 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.TopologyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/: + 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" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.TopologyConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + 400: + description: "Internal error" + put: + tags: + - "tapi-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" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object 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" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/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.Path" + 400: + description: "Internal error" + /data/context/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.LinkRef" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/: + get: + tags: + - "tapi-path-computation" + 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.RoutingConstraint" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-path-computation" + 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.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/: + get: + tags: + - "tapi-path-computation" + 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.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/service-interface-point/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - in: "body" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/service-interface-point={uuid}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePoint" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/available-capacity/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/name/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/service-interface-point={uuid}/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/total-potential-capacity/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] + responses: + 200: + description: "tapi.topology.TopologyContext" + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-topology" + summary: "creates tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: + - in: "body" + name: "tapi.topology.context.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-topology" + summary: "creates or updates tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: + - in: "body" + name: "tapi.topology.context.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-topology" + summary: "removes tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/topology-context/nw-topology-service/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NetworkTopologyService" + description: "none" + parameters: [] + responses: + 200: + description: "tapi.topology.NetworkTopologyService" + schema: + $ref: "#/definitions/tapi.topology.NetworkTopologyService" + 400: + description: "Internal error" + /data/context/topology-context/nw-topology-service/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.TopologyRef" + description: "none" + parameters: + - name: "topology-uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.topologycontext.Topology" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Topology" + schema: + $ref: "#/definitions/tapi.topology.Topology" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/boundary-node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Link" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Link" + schema: + $ref: "#/definitions/tapi.topology.Link" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.ValidationMechanism" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "validation-mechanism" + in: "path" + description: "Id of validation-mechanism" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.ValidationMechanism" + schema: + $ref: "#/definitions/tapi.topology.ValidationMechanism" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.topology.Node" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.topology.Node" + schema: + $ref: "#/definitions/tapi.topology.topology.Node" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.TopologyRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.node.NodeEdgePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.node.NodeEdgePoint" + schema: + $ref: "#/definitions/tapi.topology.node.NodeEdgePoint" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{aggregated-node-edge-point-node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-cep-layer-protocol={layer-protocol-qualifier}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NepLayerProtocolCapability" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "layer-protocol-qualifier" + in: "path" + description: "Id of available-cep-layer-protocol" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NepLayerProtocolCapability" + schema: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" + schema: + $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ + : get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.ceplist.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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.ceplist.ConnectionEndPoint" + schema: + $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/aggregated-connection-end-point={topology-uuid},{aggregated-connection-end-point-node-uuid},{aggregated-connection-end-point-node-edge-point-uuid},{aggregated-connection-end-point-connection-end-point-uuid}/ + : get: + tags: + - "tapi-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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-connection-end-point" + required: true + type: "string" + - name: "aggregated-connection-end-point-node-uuid" + in: "path" + description: "Id of aggregated-connection-end-point" + required: true + type: "string" + - name: "aggregated-connection-end-point-node-edge-point-uuid" + in: "path" + description: "Id of 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.ConnectionEndPointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/client-node-edge-point={topology-uuid},{client-node-edge-point-node-uuid},{client-node-edge-point-node-edge-point-uuid}/ + : get: + tags: + - "tapi-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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of client-node-edge-point" + required: true + type: "string" + - name: "client-node-edge-point-node-uuid" + in: "path" + description: "Id of client-node-edge-point" + required: true + type: "string" + - name: "client-node-edge-point-node-edge-point-uuid" + in: "path" + description: "Id of client-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MepMipList" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MepMipList" + schema: + $ref: "#/definitions/tapi.oam.MepMipList" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mep={meg-uuid},{mep-local-id}/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MepRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "meg-uuid" + in: "path" + description: "Id of mep" + required: true + type: "string" + - name: "mep-local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MepRef" + schema: + $ref: "#/definitions/tapi.oam.MepRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mip={meg-uuid},{mip-local-id}/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MipRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "meg-uuid" + in: "path" + description: "Id of mip" + required: true + type: "string" + - name: "mip-local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MipRef" + schema: + $ref: "#/definitions/tapi.oam.MipRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load balancing/Resilience)\ + \ should be considered experimental" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "service-interface-point-uuid" + in: "path" + description: "Id of mapped-service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePointRef" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroup" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroup" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-rule-group-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroupRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.InterRuleGroup" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.InterRuleGroup" + schema: + $ref: "#/definitions/tapi.topology.InterRuleGroup" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + - name: "associated-node-rule-group-node-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + - name: "associated-node-rule-group-node-rule-group-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroupRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Rule" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Rule" + schema: + $ref: "#/definitions/tapi.topology.Rule" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-node-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Rule" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Rule" + schema: + $ref: "#/definitions/tapi.topology.Rule" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /operations/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/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/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/create-oam-job/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.CreateOamJob" + description: "operates on tapi.oam.CreateOamJob" + parameters: + - in: "body" + name: "tapi.oam.createoamjob.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.createoamjob.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.CreateOamJob" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/create-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.CreateOamProfile" + description: "operates on tapi.oam.CreateOamProfile" + parameters: + - in: "body" + name: "tapi.oam.createoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.createoamprofile.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.CreateOamProfile" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/create-oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.CreateOamServicePoint" + description: "operates on tapi.oam.CreateOamServicePoint" + parameters: + - in: "body" + name: "tapi.oam.createoamservicepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.createoamservicepoint.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.CreateOamServicePoint" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/create-oam-service/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.CreateOamService" + description: "operates on tapi.oam.CreateOamService" + parameters: + - in: "body" + name: "tapi.oam.createoamservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.createoamservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.CreateOamService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/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/delete-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.DeleteNotificationSubscriptionService" + description: "operates on tapi.notification.DeleteNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.deletenotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-oam-job/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamJob" + description: "operates on tapi.oam.DeleteOamJob" + parameters: + - in: "body" + name: "tapi.oam.deleteoamjob.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.deleteoamjob.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamProfile" + description: "operates on tapi.oam.DeleteOamProfile" + parameters: + - in: "body" + name: "tapi.oam.deleteoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.deleteoamprofile.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamServicePoint" + description: "operates on tapi.oam.DeleteOamServicePoint" + parameters: + - in: "body" + name: "tapi.oam.deleteoamservicepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.deleteoamservicepoint.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-oam-service/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamService" + description: "operates on tapi.oam.DeleteOamService" + parameters: + - in: "body" + name: "tapi.oam.deleteoamservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.deleteoamservice.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/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/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/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/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/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/get-link-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetLinkDetails" + description: "operates on tapi.topology.GetLinkDetails" + parameters: + - in: "body" + name: "tapi.topology.getlinkdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getlinkdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetLinkDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-meg/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.GetMeg" + description: "operates on tapi.oam.GetMeg" + parameters: + - in: "body" + name: "tapi.oam.getmeg.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getmeg.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetMeg" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-node-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetNodeDetails" + description: "operates on tapi.topology.GetNodeDetails" + parameters: + - in: "body" + name: "tapi.topology.getnodedetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getnodedetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetNodeDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-node-edge-point-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetNodeEdgePointDetails" + description: "operates on tapi.topology.GetNodeEdgePointDetails" + parameters: + - in: "body" + name: "tapi.topology.getnodeedgepointdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetNodeEdgePointDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-list/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationList" + description: "operates on tapi.notification.GetNotificationList" + parameters: + - in: "body" + name: "tapi.notification.getnotificationlist.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.getnotificationlist.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-subscription-service-details/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + description: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + parameters: + - in: "body" + name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-subscription-service-list/: + post: + tags: + - "tapi-notification" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-job-list/: + post: + tags: + - "tapi-oam" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamJobList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-job/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.GetOamJob" + description: "operates on tapi.oam.GetOamJob" + parameters: + - in: "body" + name: "tapi.oam.getoamjob.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getoamjob.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamJob" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-profile-list/: + post: + tags: + - "tapi-oam" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamProfileList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.GetOamProfile" + description: "operates on tapi.oam.GetOamProfile" + parameters: + - in: "body" + name: "tapi.oam.getoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getoamprofile.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamProfile" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-service-list/: + post: + tags: + - "tapi-oam" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamServiceList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.GetOamServicePoint" + description: "operates on tapi.oam.GetOamServicePoint" + parameters: + - in: "body" + name: "tapi.oam.getoamservicepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getoamservicepoint.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamServicePoint" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-service/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.GetOamService" + description: "operates on tapi.oam.GetOamService" + parameters: + - in: "body" + name: "tapi.oam.getoamservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getoamservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-service-interface-point-details/: + post: + tags: + - "tapi-common" + summary: "operates on tapi.common.GetServiceInterfacePointDetails" + description: "operates on tapi.common.GetServiceInterfacePointDetails" + parameters: + - in: "body" + name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.common.GetServiceInterfacePointDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-service-interface-point-list/: + post: + tags: + - "tapi-common" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.common.GetServiceInterfacePointList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-supported-notification-types/: + post: + tags: + - "tapi-notification" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetSupportedNotificationTypes" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-topology-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetTopologyDetails" + description: "operates on tapi.topology.GetTopologyDetails" + parameters: + - in: "body" + name: "tapi.topology.gettopologydetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.gettopologydetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetTopologyDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-topology-list/: + post: + tags: + - "tapi-topology" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetTopologyList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/optimize-p-2-p-path/: + 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/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/update-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.UpdateNotificationSubscriptionService" + description: "operates on tapi.notification.UpdateNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.UpdateNotificationSubscriptionService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-oam-job/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamJob" + description: "operates on tapi.oam.UpdateOamJob" + parameters: + - in: "body" + name: "tapi.oam.updateoamjob.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.updateoamjob.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.UpdateOamJob" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamProfile" + description: "operates on tapi.oam.UpdateOamProfile" + parameters: + - in: "body" + name: "tapi.oam.updateoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.updateoamprofile.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.UpdateOamProfile" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamServicePoint" + description: "operates on tapi.oam.UpdateOamServicePoint" + parameters: + - in: "body" + name: "tapi.oam.updateoamservicepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.updateoamservicepoint.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.UpdateOamServicePoint" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-oam-service/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamService" + description: "operates on tapi.oam.UpdateOamService" + parameters: + - in: "body" + name: "tapi.oam.updateoamservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.updateoamservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.UpdateOamService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-service-interface-point/: + post: + tags: + - "tapi-common" + summary: "operates on tapi.common.UpdateServiceInterfacePoint" + description: "operates on tapi.common.UpdateServiceInterfacePoint" + parameters: + - in: "body" + name: "tapi.common.updateserviceinterfacepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.common.updateserviceinterfacepoint.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" +definitions: + tapi.common.AdminStatePac: + type: "object" + properties: + operational-state: + description: "none" + $ref: "#/definitions/tapi.common.OperationalState" + lifecycle-state: + description: "none" + $ref: "#/definitions/tapi.common.LifecycleState" + administrative-state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + tapi.common.AdministrativeState: + type: "string" + enum: + - "LOCKED" + - "UNLOCKED" + tapi.common.Capacity: + type: "object" + properties: + total-size: + description: "Total capacity of the TopologicalEntity in MB/s. In case of\ + \ bandwidthProfile, this is expected to same as the committedInformationRate." + $ref: "#/definitions/tapi.common.CapacityValue" + tapi.common.CapacityPac: + type: "object" + properties: + available-capacity: + description: "Capacity available to be assigned." + $ref: "#/definitions/tapi.common.Capacity" + total-potential-capacity: + description: "An optimistic view of the capacity of the TopologicalEntity\ + \ assuming that any shared capacity is available to be taken." + $ref: "#/definitions/tapi.common.Capacity" + tapi.common.CapacityUnit: + type: "string" + enum: + - "TB" + - "TBPS" + - "GB" + - "GBPS" + - "MB" + - "MBPS" + - "KB" + - "KBPS" + - "GHz" + - "MHz" + tapi.common.CapacityValue: + type: "object" + properties: + value: + type: "integer" + format: "int32" + description: "none" + unit: + description: "none" + $ref: "#/definitions/tapi.common.CapacityUnit" + tapi.common.Context: + allOf: + - $ref: "#/definitions/tapi.common.TapiContext" + - $ref: "#/definitions/tapi.connectivity.ContextAugmentation4" + - $ref: "#/definitions/tapi.notification.ContextAugmentation1" + - $ref: "#/definitions/tapi.oam.ContextAugmentation3" + - $ref: "#/definitions/tapi.path.computation.ContextAugmentation2" + - $ref: "#/definitions/tapi.topology.ContextAugmentation5" + tapi.common.DirectiveValue: + type: "string" + 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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a UUID\ + \ in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.common.LayerProtocolName: + type: "string" + enum: + - "ODU" + - "ETH" + - "DSR" + - "PHOTONIC_MEDIA" + tapi.common.LifecycleState: + type: "string" + enum: + - "PLANNED" + - "POTENTIAL_AVAILABLE" + - "POTENTIAL_BUSY" + - "INSTALLED" + - "PENDING_REMOVAL" + tapi.common.LocalClass: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + local-id: + type: "string" + description: "none" + tapi.common.NameAndValue: + type: "object" + properties: + value-name: + type: "string" + description: "The name of the value. The value need not have a name." + value: + type: "string" + description: "The value" + tapi.common.OperationalState: + type: "string" + enum: + - "DISABLED" + - "ENABLED" + tapi.common.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" + description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ + \ termination and adaptation functions of one or more transport layers. \r\ + \n The structure of LTP supports all transport protocols including\ + \ circuit and packet forms." + tapi.common.ServiceInterfacePointRef: + type: "object" + properties: + service-interface-point-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-common:service-interface-point/tapi-common:uuid" + tapi.common.TapiContext: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + service-interface-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + description: "The Network Control Domain (NCD) object class represents the scope\ + \ of control that a particular SDN controller has with respect to a particular\ + \ network, (i.e., encompassing a designated set of interconnected (virtual)\ + \ network elements)." + tapi.common.TerminationDirection: + type: "string" + enum: + - "BIDIRECTIONAL" + - "SINK" + - "SOURCE" + - "UNDEFINED_OR_UNKNOWN" + tapi.common.TerminationPac: + type: "object" + properties: + termination-direction: + description: "The overall directionality of the LP. \r\n -\ + \ A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ + \ - A SINK LP can only contain elements with SINK flows or CONTRA_DIRECTION_SOURCE\ + \ flows\r\n - A SOURCE LP can only contain SOURCE flows or\ + \ CONTRA_DIRECTION_SINK flows" + $ref: "#/definitions/tapi.common.TerminationDirection" + termination-state: + description: "Indicates whether the layer is terminated and if so how." + $ref: "#/definitions/tapi.common.TerminationState" + tapi.common.TerminationState: + type: "string" + enum: + - "LP_CAN_NEVER_TERMINATE" + - "LT_NOT_TERMINATED" + - "TERMINATED_SERVER_TO_CLIENT_FLOW" + - "TERMINATED_CLIENT_TO_SERVER_FLOW" + - "TERMINATED_BIDIRECTIONAL" + - "LT_PERMENANTLY_TERMINATED" + - "TERMINATION_STATE_UNKNOWN" + tapi.common.TimeInterval: + type: "object" + properties: + period: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.TimePeriod" + tapi.common.TimePeriod: + type: "object" + properties: + value: + type: "integer" + format: "int32" + description: "none" + unit: + description: "none" + $ref: "#/definitions/tapi.common.TimeUnit" + tapi.common.TimeRange: + type: "object" + properties: + end-time: + type: "string" + description: "none" + start-time: + type: "string" + description: "none" + tapi.common.TimeUnit: + type: "string" + enum: + - "YEARS" + - "MONTHS" + - "DAYS" + - "HOURS" + - "MINUTES" + - "SECONDS" + - "MILLISECONDS" + - "MICROSECONDS" + - "NANOSECONDS" + - "PICOSECONDS" + tapi.common.getserviceinterfacepointdetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.common.getserviceinterfacepointdetails.Output: + type: "object" + properties: + sip: + description: "none" + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + tapi.common.getserviceinterfacepointlist.Output: + type: "object" + properties: + sip: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + tapi.common.updateserviceinterfacepoint.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + tapi.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" + bounding-node: + description: "none" + $ref: "#/definitions/tapi.topology.NodeRef" + 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: + protection-role: + description: "none" + $ref: "#/definitions/tapi.connectivity.ProtectionRole" + 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" + 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:node-edge-point/tapi-connectivity:cep-list/tapi-connectivity:connection-end-point/tapi-connectivity:uuid" + description: "none" + 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.ConnectivityConstraint: + type: "object" + properties: + schedule: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + requested-capacity: + description: "none" + $ref: "#/definitions/tapi.common.Capacity" + diversity-exclusion: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + 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\r\n Class of Service Name." + service-type: + description: "none" + $ref: "#/definitions/tapi.connectivity.ServiceType" + coroute-inclusion: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + tapi.connectivity.ConnectivityContext: + type: "object" + properties: + connectivity-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectivityService" + connection: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.Connection" + tapi.connectivity.ConnectivityService: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + connection: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "The ForwardingConstruct (FC) object class models enabled potential\ + \ for forwarding between two or more LTPs and like the LTP supports any transport\ + \ protocol including all circuit and packet forms.\r\n At the lowest\ + \ level of recursion, a FC represents a cross-connection within an NE." + 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" + direction: + description: "The orientation of defined flow at the EndPoint." + $ref: "#/definitions/tapi.common.PortDirection" + capacity: + description: "none" + $ref: "#/definitions/tapi.common.Capacity" + protecting-connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + description: "The association of the FC to LTPs is made via EndPoints.\r\n \ + \ The EndPoint (EP) object class models the access to the FC function.\ + \ \r\n The traffic forwarding between the associated EPs of the\ + \ FC depends upon the type of FC and may be associated with FcSwitch object\ + \ instances. \r\n In cases where there is resilience the EndPoint\ + \ may convey the resilience role of the access to the FC. \r\n \ + \ It can represent a protected (resilient/reliable) point or a protecting\ + \ (unreliable working or protection) point.\r\n The EP replaces\ + \ the Protection Unit of a traditional protection model. \r\n The\ + \ ForwadingConstruct can be considered as a component and the EndPoint as\ + \ a Port on that component" + tapi.connectivity.ConnectivityServiceEndPointRef: + allOf: + - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + - type: "object" + properties: + connectivity-service-end-point-local-id: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-connectivity:connectivity-context/tapi-connectivity:connectivity-service/tapi-connectivity:end-point/tapi-connectivity:local-id" + description: "none" + tapi.connectivity.ConnectivityServiceRef: + type: "object" + properties: + 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.ContextAugmentation4: + 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.NodeEdgePointAugmentation1: + type: "object" + properties: + cep-list: + description: "none" + $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.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." + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" + hold-off-time: + type: "integer" + format: "int32" + description: "This attribute indicates the time, in milliseconds, between\ + \ declaration of signal degrade or signal fail, and the initialization of\ + \ the protection switching algorithm." + 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 + selection-control: + description: "Degree of administrative control applied to the switch selection." + $ref: "#/definitions/tapi.connectivity.SelectionControl" + preferred-restoration-layer: + type: "array" + description: "Indicate which layer this resilience parameters package configured\ + \ for." + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + restore-priority: + type: "integer" + format: "int32" + description: "none" + restoration-policy: + description: "none" + $ref: "#/definitions/tapi.topology.RestorationPolicy" + restoration-coordinate-type: + description: " The coordination mechanism between multi-layers." + $ref: "#/definitions/tapi.connectivity.CoordinateType" + is-coordinated-switching-both-ends: + type: "boolean" + description: "Is operating such that switching at both ends of each flow acorss\ + \ the FC is coordinated at both ingress and egress ends." + default: false + fault-condition-determination: + type: "string" + description: "none" + is-frozen: + type: "boolean" + description: "Temporarily prevents any switch action to be taken and, as such,\ + \ freezes the current state. \r\n Until the freeze is cleared,\ + \ additional near-end external commands are rejected and fault condition\ + \ changes and received APS messages are ignored.\r\n All\ + \ administrative controls of any aspect of protection are rejected." + default: false + reversion-mode: + description: "Indcates whether the protection scheme is revertive or non-revertive." + $ref: "#/definitions/tapi.connectivity.ReversionMode" + 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" + description: "The FC Route (FcRoute) object class models the individual routes\ + \ of an FC. \r\n The route of an FC object is represented by a\ + \ list of FCs at a lower level. \r\n Note that depending on the\ + \ service supported by an FC, an the FC can have multiple routes." + 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.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-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.UpdateConnectivityService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.connectivity.updateconnectivityservice.Output" + tapi.connectivity.ceplist.ConnectionEndPoint: + allOf: + - $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" + - $ref: "#/definitions/tapi.oam.ConnectionEndPointAugmentation1" + tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList: + allOf: + - type: "object" + properties: + connection-end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" + description: "none" + tapi.connectivity.createconnectivityservice.Input: + type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.createconnectivityservice.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityService" + tapi.connectivity.deleteconnectivityservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.getconnectiondetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.getconnectiondetails.Output: + type: "object" + properties: + connection: + description: "none" + $ref: "#/definitions/tapi.connectivity.Connection" + tapi.connectivity.getconnectionendpointdetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.getconnectionendpointdetails.Output: + type: "object" + properties: + connection-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" + tapi.connectivity.getconnectivityservicedetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.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: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.updateconnectivityservice.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityService" + tapi.notification.ContextAugmentation1: + type: "object" + properties: + notification-context: + description: "Augments the base TAPI Context with NotificationService information" + $ref: "#/definitions/tapi.notification.context.NotificationContext" + x-augmentation: + prefix: "tapi-notification" + namespace: "urn:onf:otcc:yang:tapi-notification" + tapi.notification.CreateNotificationSubscriptionService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Output" + tapi.notification.GetNotificationList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationlist.Output" + tapi.notification.GetNotificationSubscriptionServiceDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Output" + tapi.notification.GetNotificationSubscriptionServiceList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicelist.Output" + tapi.notification.GetSupportedNotificationTypes: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getsupportednotificationtypes.Output" + tapi.notification.NameAndValueChange: + type: "object" + properties: + value-name: + type: "string" + description: "The name of the value. The value need not have a name." + old-value: + type: "string" + description: "The value" + new-value: + type: "string" + description: "The value" + tapi.notification.Notification: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + target-object-type: + type: "string" + description: "none" + additional-text: + type: "string" + description: "none" + event-time-stamp: + type: "string" + description: "none" + additional-info: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.NameAndValue" + sequence-number: + type: "integer" + format: "int32" + description: "A monotonous increasing sequence number associated with the\ + \ notification.\r\n The exact semantics of how this sequence\ + \ number is assigned (per channel or subscription or source or system)\ + \ is left undefined." + target-object-identifier: + type: "string" + description: "none" + notification-type: + type: "string" + description: "none" + target-object-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.NameAndValue" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + source-indicator: + description: "none" + $ref: "#/definitions/tapi.notification.SourceIndicator" + layer-protocol-qualifier: + type: "string" + description: "none" + changed-attributes: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + description: "none" + tapi.notification.NotificationChannel: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + next-sequence-no: + type: "integer" + format: "int32" + description: "The sequence number of the next notification that will be\ + \ published on the channel" + stream-address: + type: "string" + description: "The address/location/URI of the channel/stream to which the\ + \ subscribed notifications are published.\r\n This specifics\ + \ of this is typically dependent on the implementation protocol & mechanism\ + \ and hence is typed as a string." + description: "none" + tapi.notification.NotificationSubscriptionService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.Notification" + notification-channel: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationChannel" + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + supported-object-types: + type: "array" + description: "none" + items: + type: "string" + supported-notification-types: + type: "array" + description: "none" + items: + type: "string" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + description: "none" + tapi.notification.SourceIndicator: + type: "string" + enum: + - "RESOURCE_OPERATION" + - "MANAGEMENT_OPERATION" + - "UNKNOWN" + tapi.notification.SubscriptionFilter: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + requested-notification-types: + type: "array" + description: "none" + items: + type: "string" + requested-object-identifier: + type: "array" + description: "none" + items: + type: "string" + requested-layer-protocols: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + include-content: + type: "boolean" + description: "Indicates whether the published Notification includes content\ + \ or just the Notification Id (which enables retrieval of the notification\ + \ at the later stage)" + default: false + requested-object-types: + type: "array" + description: "none" + items: + type: "string" + description: "none" + tapi.notification.SubscriptionState: + type: "string" + enum: + - "SUSPENDED" + - "ACTIVE" + tapi.notification.UpdateNotificationSubscriptionService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Output" + tapi.notification.context.NotificationContext: + allOf: + - type: "object" + properties: + notif-subscription: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" + description: "Augments the base TAPI Context with NotificationService information" + tapi.notification.createnotificationsubscriptionservice.Input: + type: "object" + properties: + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + tapi.notification.createnotificationsubscriptionservice.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.deletenotificationsubscriptionservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationlist.Input: + type: "object" + properties: + time-range: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + subscription-id: + type: "string" + description: "UUID of the associated Notification Subscription Service: An\ + \ identifier that is universally unique within an identifier space, where\ + \ the identifier space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationlist.Output: + type: "object" + properties: + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" + tapi.notification.getnotificationsubscriptionservicedetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationsubscriptionservicedetails.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.getnotificationsubscriptionservicelist.Output: + type: "object" + properties: + subscription-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.getsupportednotificationtypes.Output: + type: "object" + properties: + supported-object-types: + type: "array" + description: "none" + items: + type: "string" + supported-notification-types: + type: "array" + description: "none" + items: + type: "string" + tapi.notification.notificationcontext.Notification: + allOf: + - $ref: "#/definitions/tapi.notification.Notification" + - $ref: "#/definitions/tapi.oam.NotificationAugmentation1" + - $ref: "#/definitions/tapi.oam.NotificationAugmentation2" + tapi.notification.updatenotificationsubscriptionservice.Input: + type: "object" + properties: + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + tapi.notification.updatenotificationsubscriptionservice.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.oam.AlarmInfo: + type: "object" + properties: + perceived-severity: + description: "none" + $ref: "#/definitions/tapi.oam.PerceivedSeverityType" + probable-cause: + type: "string" + description: "none" + service-affecting: + description: "none" + $ref: "#/definitions/tapi.oam.ServiceAffecting" + is-transient: + type: "boolean" + description: "none" + default: false + tapi.oam.ConnectionEndPointAugmentation1: + type: "object" + properties: + mep-mip-list: + description: "none" + $ref: "#/definitions/tapi.oam.MepMipList" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" + tapi.oam.ContextAugmentation3: + type: "object" + properties: + oam-context: + description: "Augments the base TAPI Context with OamService information" + $ref: "#/definitions/tapi.oam.OamContext" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" + tapi.oam.CreateOamJob: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.createoamjob.Output" + tapi.oam.CreateOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.createoamprofile.Output" + tapi.oam.CreateOamService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.createoamservice.Output" + tapi.oam.CreateOamServicePoint: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.createoamservicepoint.Output" + tapi.oam.CurrentData: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + elapsed-time: + description: "none" + $ref: "#/definitions/tapi.common.TimeInterval" + period-start-time: + type: "string" + description: "This attribute indicates the start of the current monitoring\ + \ interval.\r\n The value is bound to the quarter of an\ + \ hour in case of a 15 minute interval and bound to the hour in case of\ + \ a 24 hour interval." + pm-data-pac: + description: "none" + $ref: "#/definitions/tapi.oam.PmDataPac" + history-data: + type: "array" + description: "in case of 24hr Current Data, at least 1 History Data.\r\n\ + \ In case of 15min Current Data, at least 16 History Data.\r\ + \n In case of <15min, the number of History Data shall\ + \ be able to cover a span of 4 hours." + items: + $ref: "#/definitions/tapi.oam.HistoryData" + description: "none" + tapi.oam.GetMeg: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getmeg.Output" + tapi.oam.GetOamJob: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamjob.Output" + tapi.oam.GetOamJobList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamjoblist.Output" + tapi.oam.GetOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamprofile.Output" + tapi.oam.GetOamProfileList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamprofilelist.Output" + tapi.oam.GetOamService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamservice.Output" + tapi.oam.GetOamServiceList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamservicelist.Output" + tapi.oam.GetOamServicePoint: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamservicepoint.Output" + tapi.oam.HistoryData: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + period-start-time: + type: "string" + description: "This attribute indicates the start of the monitoring interval.\r\ + \n The value is bound to the quarter of an hour in case\ + \ of a 15 minute interval and bound to the hour in case of a 24 hour interval." + pm-data-pac: + description: "none" + $ref: "#/definitions/tapi.oam.PmDataPac" + period-end-time: + type: "string" + description: "none" + description: "none" + tapi.oam.Meg: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.common.OperationalStatePac" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + mep: + type: "array" + description: "1. ME may have 0 MEPs (case of transit domains where at least\ + \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case of edge\ + \ domaind, where the peer MEP is ouside the managed domain)\r\n \ + \ 3. ME may have 2 MEPs" + items: + $ref: "#/definitions/tapi.oam.Mep" + mip: + type: "array" + description: "ME may 0, 1, or more MIPs" + items: + $ref: "#/definitions/tapi.oam.Mip" + description: "none" + tapi.oam.MegRef: + type: "object" + properties: + meg-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:uuid" + tapi.oam.Mep: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - $ref: "#/definitions/tapi.common.OperationalStatePac" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + description: "none" + tapi.oam.MepMipList: + type: "object" + properties: + mip: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.MipRef" + mep: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.MepRef" + tapi.oam.MepRef: + allOf: + - $ref: "#/definitions/tapi.oam.MegRef" + - type: "object" + properties: + mep-local-id: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:mep/tapi-oam:local-id" + description: "none" + tapi.oam.Mip: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + description: "none" + tapi.oam.MipRef: + allOf: + - $ref: "#/definitions/tapi.oam.MegRef" + - type: "object" + properties: + mip-local-id: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:mip/tapi-oam:local-id" + description: "none" + tapi.oam.NotificationAugmentation1: + type: "object" + properties: + alarm-info: + description: "none" + $ref: "#/definitions/tapi.oam.AlarmInfo" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" + tapi.oam.NotificationAugmentation2: + type: "object" + properties: + tca-info: + description: "none" + $ref: "#/definitions/tapi.oam.TcaInfo" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" + tapi.oam.OamContext: + type: "object" + properties: + oam-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamService" + oam-profile: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamProfile" + oam-job: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamJob" + meg: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.Meg" + tapi.oam.OamJob: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + schedule: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + oam-profile: + description: "none" + $ref: "#/definitions/tapi.oam.OamProfileRef" + creation-time: + type: "string" + description: "none" + oam-job-type: + type: "string" + description: "none" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamServicePointRef" + current-data: + type: "array" + description: "Granularity period of the CurrentData identifies the specific\ + \ CurrentData instance in the scope of this OamJob.\r\n \ + \ For example, typically at least\r\n one 15min and\r\n\ + \ one 24hr;\r\n optionally one additional\ + \ configurable (< 15min)" + items: + $ref: "#/definitions/tapi.oam.CurrentData" + description: "none" + tapi.oam.OamJobRef: + type: "object" + properties: + oam-job-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-job/tapi-oam:uuid" + tapi.oam.OamProfile: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + pm-threshold-data: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.PmThresholdData" + description: "none" + tapi.oam.OamProfileRef: + type: "object" + properties: + oam-profile-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-profile/tapi-oam:uuid" + tapi.oam.OamService: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamServicePoint" + meg: + description: "none" + $ref: "#/definitions/tapi.oam.MegRef" + description: "none" + tapi.oam.OamServicePoint: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + mip: + description: "none" + $ref: "#/definitions/tapi.oam.MipRef" + service-interface-point: + description: "none" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + is-mip: + type: "boolean" + description: "If true, the object is related to a MIP.\r\n \ + \ If false, the object is related to a MEP." + default: false + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + mep: + description: "none" + $ref: "#/definitions/tapi.oam.MepRef" + description: "none" + tapi.oam.OamServicePointRef: + allOf: + - $ref: "#/definitions/tapi.oam.OamServiceRef" + - type: "object" + properties: + oam-service-point-local-id: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:oam-service-point/tapi-oam:local-id" + description: "none" + tapi.oam.OamServiceRef: + type: "object" + properties: + oam-service-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:uuid" + tapi.oam.PerceivedSeverityType: + type: "string" + enum: + - "CRITICAL" + - "MAJOR" + - "MINOR" + - "WARNING" + - "CLEARED" + tapi.oam.PerceivedTcaSeverity: + type: "string" + enum: + - "WARNING" + - "CLEAR" + tapi.oam.PmDataPac: + type: "object" + properties: + suspect-interval-flag: + type: "boolean" + description: "This attribute is used to indicate that the performance data\ + \ for the current period may not be reliable. Some reasons for this to occur\ + \ are:\r\n – Suspect data were detected by the actual resource\ + \ doing data collection.\r\n – Transition of the administrativeState\ + \ attribute to/from the 'lock' state.\r\n – Transition of\ + \ the operationalState to/from the 'disabled' state.\r\n \ + \ – Scheduler setting that inhibits the collection function.\r\n \ + \ – The performance counters were reset during the interval.\r\n\ + \ – The currentData (or subclass) object instance was created\ + \ during the monitoring period." + default: false + granularity-period: + description: "none" + $ref: "#/definitions/tapi.common.TimePeriod" + tapi.oam.PmParameterValue: + type: "object" + properties: + pm-parameter-int-value: + type: "integer" + format: "int32" + description: "none" + pm-parameter-real-value: + type: "string" + description: "none" + tapi.oam.PmThresholdData: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + granularity-period: + description: "none" + $ref: "#/definitions/tapi.common.TimePeriod" + threshold-parameter: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.ThresholdParameter" + is-transient: + type: "boolean" + description: "none" + default: false + applicable-job-type: + type: "array" + description: "This attribute allows an PMThresholdData instance to be constrained\ + \ to specific job types. If an PMThresholdData instance is so configured\ + \ to be applicable to more than one job type (worst case ALL), only the\ + \ parameters relevant for the job instance will be used (non-applicable\ + \ profile parameters will be ignored)" + items: + type: "string" + description: "none" + tapi.oam.ServiceAffecting: + type: "string" + enum: + - "SERVICE_AFFECTING" + - "NOT_SERVICE_AFFECTING" + - "UNKNOWN" + tapi.oam.TcaInfo: + type: "object" + properties: + oam-job: + description: "MEF 35.1\r\n Identification of the PM Session\ + \ for which the TCA Function was configured." + $ref: "#/definitions/tapi.oam.OamJobRef" + threshold-parameter: + description: "none" + $ref: "#/definitions/tapi.oam.ThresholdParameter" + is-transient: + type: "boolean" + description: "none" + default: false + perceived-severity: + description: "none" + $ref: "#/definitions/tapi.oam.PerceivedTcaSeverity" + suspect-interval-flag: + type: "boolean" + description: "none" + default: false + measurement-interval: + type: "string" + description: "none" + tapi.oam.ThresholdCrossingQualifier: + type: "string" + enum: + - "NOT_APPLICABLE" + - "NEAR_END" + - "FAR_END" + - "BIDIRECTIONAL" + - "FORWARD" + - "BACKWARD" + tapi.oam.ThresholdParameter: + type: "object" + properties: + pm-parameter-below-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-clear-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-above-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-name: + type: "string" + description: "none" + threshold-location: + description: "none" + $ref: "#/definitions/tapi.oam.ThresholdCrossingQualifier" + tapi.oam.UpdateOamJob: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.updateoamjob.Output" + tapi.oam.UpdateOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.updateoamprofile.Output" + tapi.oam.UpdateOamService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.updateoamservice.Output" + tapi.oam.UpdateOamServicePoint: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.updateoamservicepoint.Output" + tapi.oam.createoamjob.Input: + type: "object" + properties: + schedule: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point-id: + type: "string" + description: "UUID of the associated OSEPs: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + oam-job-type: + type: "string" + description: "none" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + oam-profile-id: + type: "string" + description: "UUID of the OamProfile to be applied: An identifier that is\ + \ universally unique within an identifier space, where the identifier space\ + \ is itself globally unique, and immutable.\r\n An UUID\ + \ carries no semantics with respect to the purpose or state of the entity.\r\ + \n UUID here uses string representation as defined in\ + \ RFC 4122. The canonical representation uses lowercase characters.\r\n\ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + oam-service-id: + type: "string" + description: "UUID of the associated OamService: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.createoamjob.Output: + type: "object" + properties: + oam-job: + description: "none" + $ref: "#/definitions/tapi.oam.OamJob" + tapi.oam.createoamprofile.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + pm-threshold-data: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.PmThresholdData" + tapi.oam.createoamprofile.Output: + type: "object" + properties: + oam-profile: + description: "none" + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.createoamservice.Input: + type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamServicePoint" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.createoamservice.Output: + type: "object" + properties: + oam-service: + description: "none" + $ref: "#/definitions/tapi.oam.OamService" + tapi.oam.createoamservicepoint.Input: + type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + connectivity-service-end-point-id: + type: "string" + description: "UUID of the CSEP to be monitored: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + service-interface-point-id: + type: "string" + description: "UUID of the associated SIP to be monitored: An identifier that\ + \ is universally unique within an identifier space, where the identifier\ + \ space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose or state of\ + \ the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + oam-service-id: + type: "string" + description: "UUID of the parent OamService: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.createoamservicepoint.Output: + type: "object" + properties: + oam-service-point: + description: "none" + $ref: "#/definitions/tapi.oam.OamServicePoint" + tapi.oam.deleteoamjob.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamprofile.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamservicepoint.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getmeg.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getmeg.Output: + type: "object" + properties: + meg: + description: "none" + $ref: "#/definitions/tapi.oam.Meg" + tapi.oam.getoamjob.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamjob.Output: + type: "object" + properties: + oam-job: + description: "none" + $ref: "#/definitions/tapi.oam.OamJob" + tapi.oam.getoamjoblist.Output: + type: "object" + properties: + oam-job: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamJob" + tapi.oam.getoamprofile.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamprofile.Output: + type: "object" + properties: + oam-profile: + description: "none" + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.getoamprofilelist.Output: + type: "object" + properties: + oam-profile: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.getoamservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamservice.Output: + type: "object" + properties: + oam-service: + description: "none" + $ref: "#/definitions/tapi.oam.OamService" + tapi.oam.getoamservicelist.Output: + type: "object" + properties: + oam-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamService" + tapi.oam.getoamservicepoint.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamservicepoint.Output: + type: "object" + properties: + oam-service-point: + description: "none" + $ref: "#/definitions/tapi.oam.OamServicePoint" + tapi.oam.updateoamjob.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + schedule: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + oam-profile-id: + type: "string" + description: "UUID of the OamProfile to be applied: An identifier that is\ + \ universally unique within an identifier space, where the identifier space\ + \ is itself globally unique, and immutable.\r\n An UUID\ + \ carries no semantics with respect to the purpose or state of the entity.\r\ + \n UUID here uses string representation as defined in\ + \ RFC 4122. The canonical representation uses lowercase characters.\r\n\ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.updateoamjob.Output: + type: "object" + properties: + oam-job: + description: "none" + $ref: "#/definitions/tapi.oam.OamJob" + tapi.oam.updateoamprofile.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + pm-threshold-data: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.PmThresholdData" + tapi.oam.updateoamprofile.Output: + type: "object" + properties: + oam-profile: + description: "none" + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.updateoamservice.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamServicePoint" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.updateoamservice.Output: + type: "object" + properties: + oam-service: + description: "none" + $ref: "#/definitions/tapi.oam.OamService" + tapi.oam.updateoamservicepoint.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.updateoamservicepoint.Output: + type: "object" + properties: + oam-service-point: + description: "none" + $ref: "#/definitions/tapi.oam.OamServicePoint" + 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.PathComputationService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $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" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + optimization-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "none" + tapi.path.computation.PathObjectiveFunction: + allOf: + - $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.PathOptimizationConstraint: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + traffic-interruption: + description: "none" + $ref: "#/definitions/tapi.common.DirectiveValue" + description: "none" + 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.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.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 + tolerable-impact: + type: "string" + description: "Grades of maximum tolerable disruption to traffic." + 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" + 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" + tapi.path.computation.TopologyConstraint: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + include-node: + type: "string" + description: "This is a loose constraint - that is it is unordered and could\ + \ be a partial list" + exclude-link: + type: "string" + description: "none" + avoid-topology: + type: "string" + description: "none" + exclude-path: + type: "string" + description: "none" + include-topology: + type: "string" + description: "none" + include-path: + type: "string" + description: "none" + exclude-node-edge-point: + type: "string" + description: "none" + include-node-edge-point: + type: "string" + description: "none" + include-link: + type: "string" + description: "This is a loose constraint - that is it is unordered and could\ + \ be a partial list " + preferred-transport-layer: + description: "soft constraint requested by client to indicate the layer(s)\ + \ of transport connection that it prefers to carry the service. This could\ + \ be same as the service layer or one of the supported server layers" + $ref: "#/definitions/tapi.common.LayerProtocolName" + exclude-node: + type: "string" + description: "none" + constraint-weight: + type: "integer" + format: "int32" + description: "Zero and positive values: zero means 'strongly required to\ + \ be included', +1 means 'less strongly required to be included', etc.\r\ + \n For example the work/intended route will be calculated\ + \ considering the topologies which weights are lowest (but not negative).\r\ + \n Negative values: -1 means 'strongly required to be excluded',\ + \ -2 means 'less strongly required to be excluded', etc." + description: "The TopologyConstraint allows to specify topology entities in\ + \ order to impose specific constraints (as denoted by the attribute name)\ + \ on Connectivity/Path.\r\n The topology entities are specified\ + \ by their instance uuid rather than using references/path (to allow for mapping\ + \ to Yang 1.0).\r\n This loose typing and reference necessitates\ + \ that implementations validate not only the presence of the instance, but\ + \ also that it is of the correct type as implied by the attribute name.\r\n\ + \ If this validation fails, then the implementation is expceted\ + \ to return an error.\r\n " + tapi.path.computation.computep2ppath.Input: + type: "object" + properties: + topology-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + objective-function: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.path.computation.computep2ppath.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathComputationService" + tapi.path.computation.deletep2ppath.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.path.computation.deletep2ppath.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathComputationService" + tapi.path.computation.optimizep2ppath.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + optimization-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + objective-function: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + tapi.path.computation.optimizep2ppath.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathComputationService" + tapi.topology.ContextAugmentation5: + type: "object" + properties: + topology-context: + description: "Augments the base TAPI Context with TopologyService information" + $ref: "#/definitions/tapi.topology.TopologyContext" + x-augmentation: + prefix: "tapi-topology" + namespace: "urn:onf:otcc:yang:tapi-topology" + tapi.topology.CostCharacteristic: + type: "object" + properties: + cost-value: + type: "string" + description: "The specific cost." + cost-algorithm: + type: "string" + description: "The cost may vary based upon some properties of the TopologicalEntity.\ + \ The rules for the variation are conveyed by the costAlgorithm." + cost-name: + type: "string" + description: "The cost characteristic will related to some aspect of the TopologicalEntity\ + \ (e.g. $ cost, routing weight). This aspect will be conveyed by the costName." + tapi.topology.ForwardingRule: + type: "string" + enum: + - "MAY_FORWARD_ACROSS_GROUP" + - "MUST_FORWARD_ACROSS_GROUP" + - "CANNOT_FORWARD_ACROSS_GROUP" + - "NO_STATEMENT_ON_FORWARDING" + tapi.topology.GetLinkDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getlinkdetails.Output" + tapi.topology.GetNodeDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getnodedetails.Output" + tapi.topology.GetNodeEdgePointDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Output" + tapi.topology.GetTopologyDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.gettopologydetails.Output" + tapi.topology.GetTopologyList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.gettopologylist.Output" + tapi.topology.InterRuleGroup: + allOf: + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + associated-node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + rule: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Rule" + description: "none" + tapi.topology.LatencyCharacteristic: + type: "object" + properties: + traffic-property-name: + type: "string" + description: "The identifier of the specific traffic property to which the\ + \ queuing latency applies." + jitter-characteristic: + type: "string" + description: "High frequency deviation from true periodicity of a signal and\ + \ therefore a small high rate of change of transfer latency.\r\n \ + \ Applies to TDM systems (and not packet)." + fixed-latency-characteristic: + type: "string" + description: "A TopologicalEntity suffers delay caused by the realization\ + \ of the servers (e.g. distance related; FEC encoding etc.) along with some\ + \ client specific processing. This is the total average latency effect of\ + \ the TopologicalEntity" + wander-characteristic: + type: "string" + description: "Low frequency deviation from true periodicity of a signal and\ + \ therefore a small low rate of change of transfer latency.\r\n \ + \ Applies to TDM systems (and not packet)." + queing-latency-characteristic: + type: "string" + description: "The specific queuing latency for the traffic property." + tapi.topology.LayerProtocolTransitionPac: + type: "object" + properties: + transitioned-layer-protocol-name: + type: "array" + description: "Provides the ordered structure of layer protocol transitions\ + \ encapsulated in the TopologicalEntity. The ordering relates to the LinkPort\ + \ role." + items: + type: "string" + tapi.topology.Link: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.LayerProtocolTransitionPac" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - $ref: "#/definitions/tapi.topology.ValidationPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + restoration-policy: + description: "none" + $ref: "#/definitions/tapi.topology.RestorationPolicy" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" + direction: + description: "The directionality of the Link. \r\n Is applicable\ + \ to simple Links where all LinkEnds are BIDIRECTIONAL (the Link will\ + \ be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ + \ \r\n Is not present in more complex cases." + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "The Link object class models effective adjacency between two or\ + \ more ForwardingDomains (FD). " + tapi.topology.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.NepLayerProtocolCapability: + type: "object" + properties: + layer-protocol-qualifier: + type: "string" + description: "none" + number-of-cep-instances: + type: "integer" + format: "int32" + description: "none" + tapi.topology.NetworkTopologyService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.TopologyRef" + description: "none" + tapi.topology.Node: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + encap-topology: + description: "none" + $ref: "#/definitions/tapi.topology.TopologyRef" + node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePoint" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ + \ topological component which is used to effect forwarding of transport characteristic\ + \ information and offers the potential to enable forwarding. \r\n \ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ multiple switch matrices (FDs). " + tapi.topology.NodeEdgePoint: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.common.TerminationPac" + - type: "object" + properties: + link-port-role: + description: "Each LinkEnd of the Link has a role (e.g., symmetric, hub,\ + \ spoke, leaf, root) in the context of the Link with respect to the Link\ + \ function. " + $ref: "#/definitions/tapi.common.PortRole" + mapped-service-interface-point: + type: "array" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load\ + \ balancing/Resilience) should be considered experimental" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + available-cep-layer-protocol: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + link-port-direction: + description: "The orientation of defined flow at the LinkEnd." + $ref: "#/definitions/tapi.common.PortDirection" + description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ + \ termination and adaptation functions of one or more transport layers. \r\ + \n The structure of LTP supports all transport protocols including\ + \ circuit and packet forms." + tapi.topology.NodeEdgePointRef: + allOf: + - $ref: "#/definitions/tapi.topology.NodeRef" + - type: "object" + properties: + node-edge-point-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-edge-point/tapi-topology:uuid" + description: "none" + tapi.topology.NodeRef: + allOf: + - $ref: "#/definitions/tapi.topology.TopologyRef" + - type: "object" + properties: + node-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:uuid" + description: "none" + tapi.topology.NodeRuleGroup: + allOf: + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + inter-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.InterRuleGroup" + rule: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Rule" + composed-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "none" + tapi.topology.NodeRuleGroupRef: + allOf: + - $ref: "#/definitions/tapi.topology.NodeRef" + - type: "object" + properties: + node-rule-group-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-rule-group/tapi-topology:uuid" + description: "none" + tapi.topology.ProtectionType: + type: "string" + enum: + - "NO_PROTECTION" + - "ONE_PLUS_ONE_PROTECTION" + - "ONE_FOR_ONE_PROTECTION" + - "ONE_FOR_N_PROTECTION" + - "M_FOR_N_PROTECTION" + - "ONE_FOR_ONE_BY_N" + tapi.topology.RestorationPolicy: + type: "string" + enum: + - "PER_DOMAIN_RESTORATION" + - "END_TO_END_RESTORATION" + - "NA" + - "DYNAMIC_RESTORATION" + - "PRE_COMPUTED_RESTORATION" + tapi.topology.RiskCharacteristic: + type: "object" + properties: + risk-characteristic-name: + type: "string" + description: "The name of the risk characteristic. The characteristic may\ + \ be related to a specific degree of closeness. \r\n For\ + \ example a particular characteristic may apply to failures that are localized\ + \ (e.g. to one side of a road) where as another characteristic may relate\ + \ to failures that have a broader impact (e.g. both sides of a road that\ + \ crosses a bridge).\r\n Depending upon the importance of\ + \ the traffic being routed different risk characteristics will be evaluated." + risk-identifier-list: + type: "array" + description: "A list of the identifiers of each physical/geographic unit (with\ + \ the specific risk characteristic) that is related to a segment of the\ + \ TopologicalEntity." + items: + type: "string" + tapi.topology.RiskParameterPac: + type: "object" + properties: + risk-characteristic: + type: "array" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + items: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + tapi.topology.Rule: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + override-priority: + type: "integer" + format: "int32" + description: "none" + forwarding-rule: + description: "none" + $ref: "#/definitions/tapi.topology.ForwardingRule" + rule-type: + description: "none" + $ref: "#/definitions/tapi.topology.RuleType" + description: "none" + tapi.topology.RuleType: + type: "string" + enum: + - "FORWARDING" + - "CAPACITY" + - "COST" + - "TIMING" + - "RISK" + - "GROUPING" + tapi.topology.Topology: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + link: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Link" + node: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Node" + boundary-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ + \ topological component which is used to effect forwarding of transport characteristic\ + \ information and offers the potential to enable forwarding. \r\n \ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ multiple switch matrices (FDs). " + tapi.topology.TopologyContext: + type: "object" + properties: + nw-topology-service: + description: "none" + $ref: "#/definitions/tapi.topology.NetworkTopologyService" + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.TopologyRef: + type: "object" + properties: + topology-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:uuid" + tapi.topology.TransferCostPac: + type: "object" + properties: + cost-characteristic: + type: "array" + description: "The list of costs where each cost relates to some aspect of\ + \ the TopologicalEntity." + items: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + tapi.topology.TransferIntegrityPac: + type: "object" + properties: + error-characteristic: + type: "string" + description: "Describes the degree to which the signal propagated can be errored.\ + \ \r\n Applies to TDM systems as the errored signal will\ + \ be propagated and not packet as errored packets will be discarded." + unavailable-time-characteristic: + type: "string" + description: "Describes the duration for which there may be no valid signal\ + \ propagated." + server-integrity-process-characteristic: + type: "string" + description: "Describes the effect of any server integrity enhancement process\ + \ on the characteristics of the TopologicalEntity." + delivery-order-characteristic: + type: "string" + description: "Describes the degree to which packets will be delivered out\ + \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ + \ maintain strict order." + repeat-delivery-characteristic: + type: "string" + description: "Primarily applies to packet systems where a packet may be delivered\ + \ more than once (in fault recovery for example). \r\n It\ + \ can also apply to TDM where several frames may be received twice due to\ + \ switching in a system with a large differential propagation delay." + loss-characteristic: + type: "string" + description: "Describes the acceptable characteristic of lost packets where\ + \ loss may result from discard due to errors or overflow.\r\n \ + \ Applies to packet systems and not TDM (as for TDM errored signals\ + \ are propagated unless grossly errored and overflow/underflow turns into\ + \ timing slips)." + tapi.topology.TransferTimingPac: + type: "object" + properties: + latency-characteristic: + type: "array" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + items: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + tapi.topology.ValidationMechanism: + type: "object" + properties: + layer-protocol-adjacency-validated: + type: "string" + description: "State of validatiion" + validation-mechanism: + type: "string" + description: "Name of mechanism used to validate adjacency" + validation-robustness: + type: "string" + description: "Quality of validation (i.e. how likely is the stated validation\ + \ to be invalid)" + tapi.topology.ValidationPac: + type: "object" + properties: + validation-mechanism: + type: "array" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." + items: + $ref: "#/definitions/tapi.topology.ValidationMechanism" + tapi.topology.getlinkdetails.Input: + type: "object" + properties: + link-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getlinkdetails.Output: + type: "object" + properties: + link: + description: "none" + $ref: "#/definitions/tapi.topology.Link" + tapi.topology.getnodedetails.Input: + type: "object" + properties: + node-id: + type: "string" + description: "UUID of the Node: An identifier that is universally unique within\ + \ an identifier space, where the identifier space is itself globally unique,\ + \ and immutable.\r\n An UUID carries no semantics with\ + \ respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The canonical\ + \ representation uses lowercase characters.\r\n Pattern:\ + \ [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getnodedetails.Output: + type: "object" + properties: + node: + description: "none" + $ref: "#/definitions/tapi.topology.Node" + tapi.topology.getnodeedgepointdetails.Input: + type: "object" + properties: + node-id: + type: "string" + description: "UUID of the parent Node: An identifier that is universally unique\ + \ within an identifier space, where the identifier space is itself globally\ + \ unique, and immutable.\r\n An UUID carries no semantics\ + \ with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The\ + \ canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Node's Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + node-edge-point-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getnodeedgepointdetails.Output: + type: "object" + properties: + node-edge-point: + description: "none" + $ref: "#/definitions/tapi.topology.NodeEdgePoint" + tapi.topology.gettopologydetails.Input: + type: "object" + properties: + topology-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.gettopologydetails.Output: + type: "object" + properties: + topology: + description: "none" + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.gettopologylist.Output: + type: "object" + properties: + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.node.NodeEdgePoint: + allOf: + - $ref: "#/definitions/tapi.connectivity.NodeEdgePointAugmentation1" + - $ref: "#/definitions/tapi.topology.NodeEdgePoint" + tapi.topology.topology.Node: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + encap-topology: + description: "none" + $ref: "#/definitions/tapi.topology.TopologyRef" + node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.node.NodeEdgePoint" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "none" diff --git a/OAS/tapi-odu@2019-03-31.yaml b/OAS/tapi-odu@2019-03-31.yaml new file mode 100644 index 00000000..590fb2a6 --- /dev/null +++ b/OAS/tapi-odu@2019-03-31.yaml @@ -0,0 +1,17324 @@ +--- +swagger: "2.0" +info: + description: "\r\n This module contains TAPI Odu Model definitions.\r\n \ + \ Source: TapiOdu.uml\r\n Copyright (c) 2018 Open Networking Foundation\ + \ (ONF). All rights reserved.\r\n License: This module is distributed under\ + \ the Apache License 2.0\r\n - The TAPI YANG models included in this TAPI\ + \ release are a *normative* part of the TAPI SDK.\r\n - The YANG specifications\ + \ have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG\ + \ mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Notification\ + \ Model definitions.\r\n Source: TapiNotification.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Topology\ + \ Model definitions.\r\n Source: TapiTopology.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI DSR Model\ + \ definitions.\r\n Source: TapiDsr.uml\r\n Copyright (c) 2018 Open\ + \ Networking Foundation (ONF). All rights reserved.\r\n License: This module\ + \ is distributed under the Apache License 2.0\r\n - The TAPI YANG models\ + \ included in this TAPI release are a *normative* part of the TAPI SDK.\r\n \ + \ - The YANG specifications have been generated from the corresponding UML\ + \ model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Common Model\ + \ definitions.\r\n Source: TapiCommon.uml\r\n Copyright (c) 2018\ + \ Open Networking Foundation (ONF). All rights reserved.\r\n License: This\ + \ module is distributed under the Apache License 2.0\r\n - The TAPI YANG\ + \ models included in this TAPI release are a *normative* part of the TAPI SDK.\r\ + \n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Path Computation\ + \ Model definitions.\r\n Source: TapiPathComputation.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Connectivity\ + \ Model definitions.\r\n Source: TapiConnectivity.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI OAM Model\ + \ definitions.\r\n Source: TapiOam.uml\r\n Copyright (c) 2018 Open\ + \ Networking Foundation (ONF). All rights reserved.\r\n License: This module\ + \ is distributed under the Apache License 2.0\r\n - The TAPI YANG models\ + \ included in this TAPI release are a *normative* part of the TAPI SDK.\r\n \ + \ - The YANG specifications have been generated from the corresponding UML\ + \ model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases." + version: "2.2.0" + title: "tapi-odu,tapi-notification,tapi-topology,tapi-dsr,tapi-common,tapi-path-computation,tapi-connectivity,tapi-oam\ + \ API" +host: "localhost:1234" +consumes: +- "application/yang-data+json" +produces: +- "application/yang-data+json" +paths: + /data/context/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Context" + description: "none" + parameters: [] + responses: + 200: + description: "tapi.common.Context" + schema: + $ref: "#/definitions/tapi.common.Context" + 400: + description: "Internal error" + post: + tags: + - "tapi-common" + summary: "creates tapi.common.Context" + description: "none" + parameters: + - in: "body" + name: "tapi.common.Context.body-param" + description: "tapi.common.Context to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.Context" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.Context" + description: "none" + parameters: + - in: "body" + name: "tapi.common.Context.body-param" + description: "tapi.common.Context to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.Context" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.Context" + description: "none" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.context.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" + parameters: [] + responses: + 200: + description: "tapi.connectivity.ConnectivityContext" + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.connectivity.context.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" + parameters: + - in: "body" + name: "tapi.connectivity.context.ConnectivityContext.body-param" + description: "tapi.connectivity.ConnectivityContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.connectivity.context.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" + parameters: + - in: "body" + name: "tapi.connectivity.context.ConnectivityContext.body-param" + description: "tapi.connectivity.ConnectivityContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.connectivity.context.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/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.Connection" + 400: + description: "Internal error" + /data/context/connectivity-context/connection={uuid}/bounding-node/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.topology.NodeRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connection" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRef" + 400: + description: "Internal error" + ? /data/context/connectivity-context/connection={uuid}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ + : get: + tags: + - "tapi-connectivity" + 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.ConnectionEndPointRef" + 400: + description: "Internal error" + /data/context/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.ConnectionRef" + 400: + description: "Internal error" + /data/context/connectivity-context/connection={uuid}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of 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.NameAndValue" + 400: + description: "Internal error" + /data/context/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.Route" + 400: + description: "Internal error" + ? /data/context/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.ConnectionEndPointRef" + 400: + description: "Internal error" + /data/context/connectivity-context/connection={uuid}/route={local-id}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of 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.NameAndValue" + 400: + description: "Internal error" + /data/context/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.LinkRef" + 400: + description: "Internal error" + /data/context/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.SwitchControl" + 400: + description: "Internal error" + /data/context/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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n 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.NameAndValue" + 400: + description: "Internal error" + ? /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/sub-switch-control={connection-uuid},{sub-switch-control-switch-control-uuid}/ + : get: + tags: + - "tapi-connectivity" + 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.SwitchControlRef" + 400: + description: "Internal error" + /data/context/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.Switch" + 400: + description: "Internal error" + /data/context/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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n 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.NameAndValue" + 400: + description: "Internal error" + ? /data/context/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.ConnectionEndPointRef" + 400: + description: "Internal error" + ? /data/context/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.RouteRef" + 400: + description: "Internal error" + /data/context/connectivity-context/connectivity-service/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.connectivity.connectivitycontext.ConnectivityService" + description: "none" + parameters: + - in: "body" + name: "tapi.connectivity.connectivitycontext.ConnectivityService.body-param" + description: "tapi.connectivity.connectivitycontext.ConnectivityService to\ + \ be added to list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.connectivitycontext.ConnectivityService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.connectivitycontext.ConnectivityService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.connectivitycontext.ConnectivityService" + schema: + $ref: "#/definitions/tapi.connectivity.connectivitycontext.ConnectivityService" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.connectivity.connectivitycontext.ConnectivityService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.connectivitycontext.ConnectivityService.body-param" + description: "tapi.connectivity.connectivitycontext.ConnectivityService to\ + \ be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.connectivitycontext.ConnectivityService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.connectivity.connectivitycontext.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/context/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.ConnectionRef" + 400: + description: "Internal error" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.ConnectivityConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.ConnectivityConstraint" + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.connectivity.ConnectivityConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ConnectivityConstraint.body-param" + description: "tapi.connectivity.ConnectivityConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.connectivity.ConnectivityConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ConnectivityConstraint.body-param" + description: "tapi.connectivity.ConnectivityConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.connectivity.ConnectivityConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.ConnectivityServiceRef" + 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.ConnectivityServiceRef" + 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.ConnectivityServiceRef" + 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/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.ConnectivityServiceRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.ConnectivityServiceRef" + 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.ConnectivityServiceRef" + 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/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.Capacity" + 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.Capacity" + 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.Capacity" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.CapacityValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-connectivity" + 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.CapacityValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.TimeRange" + 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.TimeRange" + 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.TimeRange" + 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/context/connectivity-context/connectivity-service={uuid}/end-point/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.connectivity.connectivityservice.EndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.connectivityservice.EndPoint.body-param" + description: "tapi.connectivity.connectivityservice.EndPoint to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.connectivityservice.EndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.connectivityservice.EndPoint" + schema: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.connectivity.connectivityservice.EndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.connectivityservice.EndPoint.body-param" + description: "tapi.connectivity.connectivityservice.EndPoint to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.connectivity.connectivityservice.EndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/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.Capacity" + 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.Capacity" + 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.Capacity" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/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.CapacityValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-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.CapacityValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/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.ConnectionEndPointRef" + 400: + description: "Internal error" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/odu-connectivity-service-end-point-spec/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduConnectivityServiceEndPointSpec" + 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.odu.OduConnectivityServiceEndPointSpec" + schema: + $ref: "#/definitions/tapi.odu.OduConnectivityServiceEndPointSpec" + 400: + description: "Internal error" + post: + tags: + - "tapi-odu" + summary: "creates tapi.odu.OduConnectivityServiceEndPointSpec" + 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.odu.OduConnectivityServiceEndPointSpec.body-param" + description: "tapi.odu.OduConnectivityServiceEndPointSpec to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.odu.OduConnectivityServiceEndPointSpec" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-odu" + summary: "creates or updates tapi.odu.OduConnectivityServiceEndPointSpec" + 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.odu.OduConnectivityServiceEndPointSpec.body-param" + description: "tapi.odu.OduConnectivityServiceEndPointSpec to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.odu.OduConnectivityServiceEndPointSpec" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-odu" + summary: "removes tapi.odu.OduConnectivityServiceEndPointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/odu-connectivity-service-end-point-spec/accepted-payload-type/ + : get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduPayloadType" + description: "This attribute is applicable when the ODU CTP object instance\ + \ represents a lower order ODU CTP Sink at the client layer of the ODUP/ODU[i]j\ + \ or ODUP/ODUj-21 adaptation function. \r\n This attribute\ + \ is a 2-digit Hex code that indicates the new accepted payload type.\r\n\ + \ Valid values are defined in Table 15-8 of ITU-T Recommendation\ + \ G.709 with one additional value UN_INTERPRETABLE." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduPayloadType" + schema: + $ref: "#/definitions/tapi.odu.OduPayloadType" + 400: + description: "Internal error" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/peer-fwd-connectivity-service-end-point/: + get: + tags: + - "tapi-connectivity" + 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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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/context/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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/server-connectivity-service-end-point/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of 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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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/context/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.ServiceInterfacePointRef" + 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.ServiceInterfacePointRef" + 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.ServiceInterfacePointRef" + 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/context/connectivity-context/connectivity-service={uuid}/name/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/resilience-constraint/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.ResilienceConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.ResilienceConstraint" + schema: + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.connectivity.ResilienceConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ResilienceConstraint.body-param" + description: "tapi.connectivity.ResilienceConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.connectivity.ResilienceConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ResilienceConstraint.body-param" + description: "tapi.connectivity.ResilienceConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.connectivity.ResilienceConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.RoutingConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/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.CostCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + 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.CostCharacteristic" + 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/context/connectivity-context/connectivity-service={uuid}/routing-constraint/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.LatencyCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-connectivity" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + 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.LatencyCharacteristic" + 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/context/connectivity-context/connectivity-service={uuid}/routing-constraint/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.RiskCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/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.RiskCharacteristic" + 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.RiskCharacteristic" + 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/context/connectivity-context/connectivity-service={uuid}/topology-constraint/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.path.computation.TopologyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.path.computation.TopologyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.TopologyConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.path.computation.TopologyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.path.computation.TopologyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/name/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/name/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] + responses: + 200: + description: "tapi.notification.context.NotificationContext" + schema: + $ref: "#/definitions/tapi.notification.context.NotificationContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: + - in: "body" + name: "tapi.notification.context.NotificationContext.body-param" + description: "tapi.notification.context.NotificationContext to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.notification.context.NotificationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: + - in: "body" + name: "tapi.notification.context.NotificationContext.body-param" + description: "tapi.notification.context.NotificationContext to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.context.NotificationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - in: "body" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NotificationSubscriptionService" + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/name/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/notification-channel/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationChannel" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NotificationChannel" + schema: + $ref: "#/definitions/tapi.notification.NotificationChannel" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.Notification" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.Notification" + schema: + $ref: "#/definitions/tapi.notification.Notification" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.SubscriptionFilter" + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + 400: + description: "Internal error" + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notification={uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.notificationcontext.Notification" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.notificationcontext.Notification" + schema: + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/additional-info={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/alarm-info/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.AlarmInfo" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.AlarmInfo" + schema: + $ref: "#/definitions/tapi.oam.AlarmInfo" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.TcaInfo" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.TcaInfo" + schema: + $ref: "#/definitions/tapi.oam.TcaInfo" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/oam-job/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamJobRef" + description: "MEF 35.1\r\n Identification of the PM Session for\ + \ which the TCA Function was configured." + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamJobRef" + schema: + $ref: "#/definitions/tapi.oam.OamJobRef" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.ThresholdParameter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.ThresholdParameter" + schema: + $ref: "#/definitions/tapi.oam.ThresholdParameter" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-above-thrs/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-below-thrs/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-clear-thrs/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + /data/context/oam-context/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.context.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: [] + responses: + 200: + description: "tapi.oam.context.OamContext" + schema: + $ref: "#/definitions/tapi.oam.context.OamContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.context.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: + - in: "body" + name: "tapi.oam.context.OamContext.body-param" + description: "tapi.oam.context.OamContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.context.OamContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.context.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: + - in: "body" + name: "tapi.oam.context.OamContext.body-param" + description: "tapi.oam.context.OamContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.context.OamContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.context.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/meg={uuid}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.oamcontext.Meg" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.oamcontext.Meg" + schema: + $ref: "#/definitions/tapi.oam.oamcontext.Meg" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.meg.Mep" + description: "1. ME may have 0 MEPs (case of transit domains where at least\ + \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case of edge\ + \ domaind, where the peer MEP is ouside the managed domain)\r\n \ + \ 3. ME may have 2 MEPs" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.meg.Mep" + schema: + $ref: "#/definitions/tapi.oam.meg.Mep" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduMepSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduMepSpec" + schema: + $ref: "#/definitions/tapi.odu.OduMepSpec" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/odu-defect/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduDefectPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduDefectPac" + schema: + $ref: "#/definitions/tapi.odu.OduDefectPac" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/odu-mep/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduMepPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduMepPac" + schema: + $ref: "#/definitions/tapi.odu.OduMepPac" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/odu-mep/deg-thr/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.DegThr" + description: "This attribute indicates the threshold level for declaring a performance\ + \ monitoring (PM) Second to be bad. The value of the threshold can be provisioned\ + \ in terms of number of errored blocks or in terms of percentage of errored\ + \ blocks. For percentage-based specification, in order to support provision\ + \ of less than 1%, the specification consists of two fields. The first field\ + \ indicates the granularity of percentage. For examples, in 1%, in 0.1%, or\ + \ in 0.01%, etc. The second field indicates the multiple of the granularity.\ + \ For number of errored block based, the value is a positive integer." + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.DegThr" + schema: + $ref: "#/definitions/tapi.odu.DegThr" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/odu-ncm/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduNcmPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduNcmPac" + schema: + $ref: "#/definitions/tapi.odu.OduNcmPac" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/odu-pm/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduPmPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduPmPac" + schema: + $ref: "#/definitions/tapi.odu.OduPmPac" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/odu-pm/uas/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.UasChoice" + description: "UnAvailable Second" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.UasChoice" + schema: + $ref: "#/definitions/tapi.odu.UasChoice" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/odu-tcm/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduTcmMepPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduTcmMepPac" + schema: + $ref: "#/definitions/tapi.odu.OduTcmMepPac" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mip={local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.meg.Mip" + description: "ME may 0, 1, or more MIPs" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.meg.Mip" + schema: + $ref: "#/definitions/tapi.oam.meg.Mip" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mip={local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduMipSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduMipSpec" + schema: + $ref: "#/definitions/tapi.odu.OduMipSpec" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-defect/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduDefectPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduDefectPac" + schema: + $ref: "#/definitions/tapi.odu.OduDefectPac" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-mip/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduMipPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduMipPac" + schema: + $ref: "#/definitions/tapi.odu.OduMipPac" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-mip/deg-thr/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.DegThr" + description: "This attribute indicates the threshold level for declaring a performance\ + \ monitoring (PM) Second to be bad. The value of the threshold can be provisioned\ + \ in terms of number of errored blocks or in terms of percentage of errored\ + \ blocks. For percentage-based specification, in order to support provision\ + \ of less than 1%, the specification consists of two fields. The first field\ + \ indicates the granularity of percentage. For examples, in 1%, in 0.1%, or\ + \ in 0.01%, etc. The second field indicates the multiple of the granularity.\ + \ For number of errored block based, the value is a positive integer." + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.DegThr" + schema: + $ref: "#/definitions/tapi.odu.DegThr" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-ncm/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduNcmPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduNcmPac" + schema: + $ref: "#/definitions/tapi.odu.OduNcmPac" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-pm/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduPmPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduPmPac" + schema: + $ref: "#/definitions/tapi.odu.OduPmPac" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-pm/uas/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.UasChoice" + description: "UnAvailable Second" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.UasChoice" + schema: + $ref: "#/definitions/tapi.odu.UasChoice" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-tcm/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduTcmMipPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduTcmMipPac" + schema: + $ref: "#/definitions/tapi.odu.OduTcmMipPac" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/odu-meg-spec/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduMegSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduMegSpec" + schema: + $ref: "#/definitions/tapi.odu.OduMegSpec" + 400: + description: "Internal error" + /data/context/oam-context/oam-job/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamJob" + description: "none" + parameters: + - in: "body" + name: "tapi.oam.OamJob.body-param" + description: "tapi.oam.OamJob to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamJob" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-job={uuid}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamJob" + schema: + $ref: "#/definitions/tapi.oam.OamJob" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamJob.body-param" + description: "tapi.oam.OamJob to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamJob" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.CurrentData" + description: "Granularity period of the CurrentData identifies the specific\ + \ CurrentData instance in the scope of this OamJob.\r\n For\ + \ example, typically at least\r\n one 15min and\r\n \ + \ one 24hr;\r\n optionally one additional configurable\ + \ (< 15min)" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.CurrentData" + schema: + $ref: "#/definitions/tapi.oam.CurrentData" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/elapsed-time/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimeInterval" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimeInterval" + schema: + $ref: "#/definitions/tapi.common.TimeInterval" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/elapsed-time/period={unit}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "unit" + in: "path" + description: "Id of period" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimePeriod" + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.HistoryData" + description: "in case of 24hr Current Data, at least 1 History Data.\r\n \ + \ In case of 15min Current Data, at least 16 History Data.\r\n\ + \ In case of <15min, the number of History Data shall be able\ + \ to cover a span of 4 hours." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.HistoryData" + schema: + $ref: "#/definitions/tapi.oam.HistoryData" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/pm-data-pac/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmDataPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmDataPac" + schema: + $ref: "#/definitions/tapi.oam.PmDataPac" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/pm-data-pac/granularity-period/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimePeriod" + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/pm-data-pac/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmDataPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmDataPac" + schema: + $ref: "#/definitions/tapi.oam.PmDataPac" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/pm-data-pac/granularity-period/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimePeriod" + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-job={uuid}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/oam-profile/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamProfileRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamProfileRef" + schema: + $ref: "#/definitions/tapi.oam.OamProfileRef" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamProfileRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamProfileRef.body-param" + description: "tapi.oam.OamProfileRef to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfileRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamProfileRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamProfileRef.body-param" + description: "tapi.oam.OamProfileRef to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfileRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamProfileRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamServicePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamServicePointRef.body-param" + description: "tapi.oam.OamServicePointRef to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamServicePointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-job={uuid}/oam-service-point={oam-service-uuid},{oam-service-point-local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamServicePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "oam-service-uuid" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "oam-service-point-local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamServicePointRef" + schema: + $ref: "#/definitions/tapi.oam.OamServicePointRef" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamServicePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "oam-service-uuid" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "oam-service-point-local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamServicePointRef.body-param" + description: "tapi.oam.OamServicePointRef to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamServicePointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamServicePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "oam-service-uuid" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "oam-service-point-local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/schedule/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimeRange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimeRange" + schema: + $ref: "#/definitions/tapi.common.TimeRange" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.TimeRange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.TimeRange" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.TimeRange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.TimeRange" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.TimeRange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamProfile" + description: "none" + parameters: + - in: "body" + name: "tapi.oam.OamProfile.body-param" + description: "tapi.oam.OamProfile to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfile" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamProfile" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamProfile" + schema: + $ref: "#/definitions/tapi.oam.OamProfile" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamProfile" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamProfile.body-param" + description: "tapi.oam.OamProfile to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfile" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamProfile" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.PmThresholdData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmThresholdData.body-param" + description: "tapi.oam.PmThresholdData to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmThresholdData" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmThresholdData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmThresholdData" + schema: + $ref: "#/definitions/tapi.oam.PmThresholdData" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.PmThresholdData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmThresholdData.body-param" + description: "tapi.oam.PmThresholdData to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmThresholdData" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.PmThresholdData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/granularity-period/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimePeriod" + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - in: "body" + name: "tapi.common.TimePeriod.body-param" + description: "tapi.common.TimePeriod to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - in: "body" + name: "tapi.common.TimePeriod.body-param" + description: "tapi.common.TimePeriod to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.ThresholdParameter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - in: "body" + name: "tapi.oam.ThresholdParameter.body-param" + description: "tapi.oam.ThresholdParameter to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.ThresholdParameter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.ThresholdParameter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.ThresholdParameter" + schema: + $ref: "#/definitions/tapi.oam.ThresholdParameter" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.ThresholdParameter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.ThresholdParameter.body-param" + description: "tapi.oam.ThresholdParameter to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.ThresholdParameter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.ThresholdParameter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-above-thrs/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-below-thrs/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-clear-thrs/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamService" + description: "none" + parameters: + - in: "body" + name: "tapi.oam.OamService.body-param" + description: "tapi.oam.OamService to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-service={uuid}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamService" + schema: + $ref: "#/definitions/tapi.oam.OamService" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamService.body-param" + description: "tapi.oam.OamService to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/meg/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MegRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MegRef" + schema: + $ref: "#/definitions/tapi.oam.MegRef" + 400: + description: "Internal error" + /data/context/oam-context/oam-service={uuid}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-service={uuid}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamServicePoint.body-param" + description: "tapi.oam.OamServicePoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamServicePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamServicePoint" + schema: + $ref: "#/definitions/tapi.oam.OamServicePoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamServicePoint.body-param" + description: "tapi.oam.OamServicePoint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamServicePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/connectivity-service-end-point/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.ConnectivityServiceEndPointRef" + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/mep/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MepRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MepRef" + schema: + $ref: "#/definitions/tapi.oam.MepRef" + 400: + description: "Internal error" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/mip/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MipRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MipRef" + schema: + $ref: "#/definitions/tapi.oam.MipRef" + 400: + description: "Internal error" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/service-interface-point/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePointRef" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: [] + responses: + 200: + description: "tapi.path.computation.PathComputationContext" + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: + - in: "body" + name: "tapi.path.computation.PathComputationContext.body-param" + description: "tapi.path.computation.PathComputationContext to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: + - in: "body" + name: "tapi.path.computation.PathComputationContext.body-param" + description: "tapi.path.computation.PathComputationContext to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathComputationService" + description: "none" + parameters: + - in: "body" + name: "tapi.path.computation.PathComputationService.body-param" + description: "tapi.path.computation.PathComputationService to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathComputationService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.PathComputationService" + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationService" + 400: + description: "Internal error" + 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.PathComputationService" + 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/context/path-computation-context/path-comp-service={uuid}/end-point/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathServiceEndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.PathServiceEndPoint.body-param" + description: "tapi.path.computation.PathServiceEndPoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathServiceEndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.PathServiceEndPoint" + schema: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-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.PathServiceEndPoint" + 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/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of 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.Capacity" + 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.Capacity" + 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.Capacity" + 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/context/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.CapacityValue" + 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.CapacityValue" + 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.CapacityValue" + 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/context/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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/service-interface-point/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePointRef" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 400: + description: "Internal error" + post: + tags: + - "tapi-path-computation" + 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.ServiceInterfacePointRef" + 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.ServiceInterfacePointRef" + 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/context/path-computation-context/path-comp-service={uuid}/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/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.PathObjectiveFunction" + 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.PathObjectiveFunction" + 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.PathObjectiveFunction" + 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/context/path-computation-context/path-comp-service={uuid}/objective-function/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/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.PathOptimizationConstraint" + 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.PathOptimizationConstraint" + 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.PathOptimizationConstraint" + 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/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/path={path-uuid}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "path-uuid" + in: "path" + description: "Id of path" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.PathRef" + schema: + $ref: "#/definitions/tapi.path.computation.PathRef" + 400: + description: "Internal error" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.RoutingConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + 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.CostCharacteristic" + 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/context/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.LatencyCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-path-computation" + 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.LatencyCharacteristic" + 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.LatencyCharacteristic" + 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/context/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.RiskCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-path-computation" + 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.RiskCharacteristic" + 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.RiskCharacteristic" + 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/context/path-computation-context/path-comp-service={uuid}/topology-constraint/: + 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.TopologyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/: + 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" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.TopologyConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + 400: + description: "Internal error" + put: + tags: + - "tapi-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" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object 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" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/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.Path" + 400: + description: "Internal error" + /data/context/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.LinkRef" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/: + get: + tags: + - "tapi-path-computation" + 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.RoutingConstraint" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-path-computation" + 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.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/: + get: + tags: + - "tapi-path-computation" + 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.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/service-interface-point/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - in: "body" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/service-interface-point={uuid}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePoint" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/available-capacity/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/name/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/service-interface-point={uuid}/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/total-potential-capacity/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] + responses: + 200: + description: "tapi.topology.TopologyContext" + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-topology" + summary: "creates tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: + - in: "body" + name: "tapi.topology.context.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-topology" + summary: "creates or updates tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: + - in: "body" + name: "tapi.topology.context.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-topology" + summary: "removes tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/topology-context/nw-topology-service/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NetworkTopologyService" + description: "none" + parameters: [] + responses: + 200: + description: "tapi.topology.NetworkTopologyService" + schema: + $ref: "#/definitions/tapi.topology.NetworkTopologyService" + 400: + description: "Internal error" + /data/context/topology-context/nw-topology-service/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.TopologyRef" + description: "none" + parameters: + - name: "topology-uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.topologycontext.Topology" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Topology" + schema: + $ref: "#/definitions/tapi.topology.Topology" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/boundary-node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Link" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Link" + schema: + $ref: "#/definitions/tapi.topology.Link" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.ValidationMechanism" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "validation-mechanism" + in: "path" + description: "Id of validation-mechanism" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.ValidationMechanism" + schema: + $ref: "#/definitions/tapi.topology.ValidationMechanism" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.topology.Node" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.topology.Node" + schema: + $ref: "#/definitions/tapi.topology.topology.Node" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.TopologyRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.node.NodeEdgePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.node.NodeEdgePoint" + schema: + $ref: "#/definitions/tapi.topology.node.NodeEdgePoint" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{aggregated-node-edge-point-node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-cep-layer-protocol={layer-protocol-qualifier}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NepLayerProtocolCapability" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "layer-protocol-qualifier" + in: "path" + description: "Id of available-cep-layer-protocol" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NepLayerProtocolCapability" + schema: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" + schema: + $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ + : get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.ceplist.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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.ceplist.ConnectionEndPoint" + schema: + $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/aggregated-connection-end-point={topology-uuid},{aggregated-connection-end-point-node-uuid},{aggregated-connection-end-point-node-edge-point-uuid},{aggregated-connection-end-point-connection-end-point-uuid}/ + : get: + tags: + - "tapi-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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-connection-end-point" + required: true + type: "string" + - name: "aggregated-connection-end-point-node-uuid" + in: "path" + description: "Id of aggregated-connection-end-point" + required: true + type: "string" + - name: "aggregated-connection-end-point-node-edge-point-uuid" + in: "path" + description: "Id of 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.ConnectionEndPointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/client-node-edge-point={topology-uuid},{client-node-edge-point-node-uuid},{client-node-edge-point-node-edge-point-uuid}/ + : get: + tags: + - "tapi-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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of client-node-edge-point" + required: true + type: "string" + - name: "client-node-edge-point-node-uuid" + in: "path" + description: "Id of client-node-edge-point" + required: true + type: "string" + - name: "client-node-edge-point-node-edge-point-uuid" + in: "path" + description: "Id of client-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MepMipList" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MepMipList" + schema: + $ref: "#/definitions/tapi.oam.MepMipList" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mep={meg-uuid},{mep-local-id}/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MepRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "meg-uuid" + in: "path" + description: "Id of mep" + required: true + type: "string" + - name: "mep-local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MepRef" + schema: + $ref: "#/definitions/tapi.oam.MepRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mip={meg-uuid},{mip-local-id}/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MipRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "meg-uuid" + in: "path" + description: "Id of mip" + required: true + type: "string" + - name: "mip-local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MipRef" + schema: + $ref: "#/definitions/tapi.oam.MipRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/ + : get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduConnectionEndPointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduConnectionEndPointSpec" + schema: + $ref: "#/definitions/tapi.odu.OduConnectionEndPointSpec" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-common/ + : get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduCommonPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduCommonPac" + schema: + $ref: "#/definitions/tapi.odu.OduCommonPac" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-ctp/ + : get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduCtpPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduCtpPac" + schema: + $ref: "#/definitions/tapi.odu.OduCtpPac" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-protection/ + : get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduProtectionPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduProtectionPac" + schema: + $ref: "#/definitions/tapi.odu.OduProtectionPac" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-term-and-adapter/ + : get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduTerminationAndClientAdaptationPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduTerminationAndClientAdaptationPac" + schema: + $ref: "#/definitions/tapi.odu.OduTerminationAndClientAdaptationPac" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-term-and-adapter/accepted-payload-type/ + : get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduPayloadType" + description: "This attribute is applicable when the ODU CTP object instance\ + \ represents a lower order ODU CTP Sink at the client layer of the ODUP/ODU[i]j\ + \ or ODUP/ODUj-21 adaptation function. \r\n This attribute\ + \ is a 2-digit Hex code that indicates the new accepted payload type.\r\n\ + \ Valid values are defined in Table 15-8 of ITU-T Recommendation\ + \ G.709 with one additional value UN_INTERPRETABLE." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduPayloadType" + schema: + $ref: "#/definitions/tapi.odu.OduPayloadType" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/parent-node-edge-point/ + : get: + tags: + - "tapi-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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load balancing/Resilience)\ + \ should be considered experimental" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "service-interface-point-uuid" + in: "path" + description: "Id of mapped-service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePointRef" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/odu-node-edge-point-spec/ + : get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduNodeEdgePointSpec" + description: "Augments the base LayerProtocol information in NodeEdgePoint with\ + \ ODU-specific information" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduNodeEdgePointSpec" + schema: + $ref: "#/definitions/tapi.odu.OduNodeEdgePointSpec" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/odu-node-edge-point-spec/odu-pool/ + : get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduPoolPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduPoolPac" + schema: + $ref: "#/definitions/tapi.odu.OduPoolPac" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroup" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroup" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-rule-group-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroupRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.InterRuleGroup" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.InterRuleGroup" + schema: + $ref: "#/definitions/tapi.topology.InterRuleGroup" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + - name: "associated-node-rule-group-node-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + - name: "associated-node-rule-group-node-rule-group-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroupRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Rule" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Rule" + schema: + $ref: "#/definitions/tapi.topology.Rule" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-node-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Rule" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Rule" + schema: + $ref: "#/definitions/tapi.topology.Rule" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /operations/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/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/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/create-oam-job/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.CreateOamJob" + description: "operates on tapi.oam.CreateOamJob" + parameters: + - in: "body" + name: "tapi.oam.createoamjob.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.createoamjob.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.CreateOamJob" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/create-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.CreateOamProfile" + description: "operates on tapi.oam.CreateOamProfile" + parameters: + - in: "body" + name: "tapi.oam.createoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.createoamprofile.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.CreateOamProfile" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/create-oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.CreateOamServicePoint" + description: "operates on tapi.oam.CreateOamServicePoint" + parameters: + - in: "body" + name: "tapi.oam.createoamservicepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.createoamservicepoint.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.CreateOamServicePoint" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/create-oam-service/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.CreateOamService" + description: "operates on tapi.oam.CreateOamService" + parameters: + - in: "body" + name: "tapi.oam.createoamservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.createoamservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.CreateOamService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/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/delete-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.DeleteNotificationSubscriptionService" + description: "operates on tapi.notification.DeleteNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.deletenotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-oam-job/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamJob" + description: "operates on tapi.oam.DeleteOamJob" + parameters: + - in: "body" + name: "tapi.oam.deleteoamjob.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.deleteoamjob.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamProfile" + description: "operates on tapi.oam.DeleteOamProfile" + parameters: + - in: "body" + name: "tapi.oam.deleteoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.deleteoamprofile.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamServicePoint" + description: "operates on tapi.oam.DeleteOamServicePoint" + parameters: + - in: "body" + name: "tapi.oam.deleteoamservicepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.deleteoamservicepoint.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-oam-service/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamService" + description: "operates on tapi.oam.DeleteOamService" + parameters: + - in: "body" + name: "tapi.oam.deleteoamservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.deleteoamservice.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/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/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/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/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/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/get-link-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetLinkDetails" + description: "operates on tapi.topology.GetLinkDetails" + parameters: + - in: "body" + name: "tapi.topology.getlinkdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getlinkdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetLinkDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-meg/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.GetMeg" + description: "operates on tapi.oam.GetMeg" + parameters: + - in: "body" + name: "tapi.oam.getmeg.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getmeg.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetMeg" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-node-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetNodeDetails" + description: "operates on tapi.topology.GetNodeDetails" + parameters: + - in: "body" + name: "tapi.topology.getnodedetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getnodedetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetNodeDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-node-edge-point-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetNodeEdgePointDetails" + description: "operates on tapi.topology.GetNodeEdgePointDetails" + parameters: + - in: "body" + name: "tapi.topology.getnodeedgepointdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetNodeEdgePointDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-list/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationList" + description: "operates on tapi.notification.GetNotificationList" + parameters: + - in: "body" + name: "tapi.notification.getnotificationlist.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.getnotificationlist.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-subscription-service-details/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + description: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + parameters: + - in: "body" + name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-subscription-service-list/: + post: + tags: + - "tapi-notification" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-job-list/: + post: + tags: + - "tapi-oam" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamJobList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-job/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.GetOamJob" + description: "operates on tapi.oam.GetOamJob" + parameters: + - in: "body" + name: "tapi.oam.getoamjob.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getoamjob.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamJob" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-profile-list/: + post: + tags: + - "tapi-oam" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamProfileList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.GetOamProfile" + description: "operates on tapi.oam.GetOamProfile" + parameters: + - in: "body" + name: "tapi.oam.getoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getoamprofile.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamProfile" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-service-list/: + post: + tags: + - "tapi-oam" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamServiceList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.GetOamServicePoint" + description: "operates on tapi.oam.GetOamServicePoint" + parameters: + - in: "body" + name: "tapi.oam.getoamservicepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getoamservicepoint.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamServicePoint" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-service/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.GetOamService" + description: "operates on tapi.oam.GetOamService" + parameters: + - in: "body" + name: "tapi.oam.getoamservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getoamservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-service-interface-point-details/: + post: + tags: + - "tapi-common" + summary: "operates on tapi.common.GetServiceInterfacePointDetails" + description: "operates on tapi.common.GetServiceInterfacePointDetails" + parameters: + - in: "body" + name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.common.GetServiceInterfacePointDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-service-interface-point-list/: + post: + tags: + - "tapi-common" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.common.GetServiceInterfacePointList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-supported-notification-types/: + post: + tags: + - "tapi-notification" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetSupportedNotificationTypes" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-topology-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetTopologyDetails" + description: "operates on tapi.topology.GetTopologyDetails" + parameters: + - in: "body" + name: "tapi.topology.gettopologydetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.gettopologydetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetTopologyDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-topology-list/: + post: + tags: + - "tapi-topology" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetTopologyList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/optimize-p-2-p-path/: + 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/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/update-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.UpdateNotificationSubscriptionService" + description: "operates on tapi.notification.UpdateNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.UpdateNotificationSubscriptionService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-oam-job/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamJob" + description: "operates on tapi.oam.UpdateOamJob" + parameters: + - in: "body" + name: "tapi.oam.updateoamjob.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.updateoamjob.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.UpdateOamJob" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamProfile" + description: "operates on tapi.oam.UpdateOamProfile" + parameters: + - in: "body" + name: "tapi.oam.updateoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.updateoamprofile.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.UpdateOamProfile" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamServicePoint" + description: "operates on tapi.oam.UpdateOamServicePoint" + parameters: + - in: "body" + name: "tapi.oam.updateoamservicepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.updateoamservicepoint.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.UpdateOamServicePoint" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-oam-service/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamService" + description: "operates on tapi.oam.UpdateOamService" + parameters: + - in: "body" + name: "tapi.oam.updateoamservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.updateoamservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.UpdateOamService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-service-interface-point/: + post: + tags: + - "tapi-common" + summary: "operates on tapi.common.UpdateServiceInterfacePoint" + description: "operates on tapi.common.UpdateServiceInterfacePoint" + parameters: + - in: "body" + name: "tapi.common.updateserviceinterfacepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.common.updateserviceinterfacepoint.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" +definitions: + tapi.common.AdminStatePac: + type: "object" + properties: + operational-state: + description: "none" + $ref: "#/definitions/tapi.common.OperationalState" + lifecycle-state: + description: "none" + $ref: "#/definitions/tapi.common.LifecycleState" + administrative-state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + tapi.common.AdministrativeState: + type: "string" + enum: + - "LOCKED" + - "UNLOCKED" + tapi.common.Capacity: + type: "object" + properties: + total-size: + description: "Total capacity of the TopologicalEntity in MB/s. In case of\ + \ bandwidthProfile, this is expected to same as the committedInformationRate." + $ref: "#/definitions/tapi.common.CapacityValue" + tapi.common.CapacityPac: + type: "object" + properties: + available-capacity: + description: "Capacity available to be assigned." + $ref: "#/definitions/tapi.common.Capacity" + total-potential-capacity: + description: "An optimistic view of the capacity of the TopologicalEntity\ + \ assuming that any shared capacity is available to be taken." + $ref: "#/definitions/tapi.common.Capacity" + tapi.common.CapacityUnit: + type: "string" + enum: + - "TB" + - "TBPS" + - "GB" + - "GBPS" + - "MB" + - "MBPS" + - "KB" + - "KBPS" + - "GHz" + - "MHz" + tapi.common.CapacityValue: + type: "object" + properties: + value: + type: "integer" + format: "int32" + description: "none" + unit: + description: "none" + $ref: "#/definitions/tapi.common.CapacityUnit" + tapi.common.Context: + allOf: + - $ref: "#/definitions/tapi.common.TapiContext" + - $ref: "#/definitions/tapi.connectivity.ContextAugmentation4" + - $ref: "#/definitions/tapi.notification.ContextAugmentation1" + - $ref: "#/definitions/tapi.oam.ContextAugmentation3" + - $ref: "#/definitions/tapi.path.computation.ContextAugmentation2" + - $ref: "#/definitions/tapi.topology.ContextAugmentation5" + tapi.common.DirectiveValue: + type: "string" + 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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a UUID\ + \ in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.common.LayerProtocolName: + type: "string" + enum: + - "ODU" + - "ETH" + - "DSR" + - "PHOTONIC_MEDIA" + tapi.common.LifecycleState: + type: "string" + enum: + - "PLANNED" + - "POTENTIAL_AVAILABLE" + - "POTENTIAL_BUSY" + - "INSTALLED" + - "PENDING_REMOVAL" + tapi.common.LocalClass: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + local-id: + type: "string" + description: "none" + tapi.common.NameAndValue: + type: "object" + properties: + value-name: + type: "string" + description: "The name of the value. The value need not have a name." + value: + type: "string" + description: "The value" + tapi.common.OperationalState: + type: "string" + enum: + - "DISABLED" + - "ENABLED" + tapi.common.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" + description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ + \ termination and adaptation functions of one or more transport layers. \r\ + \n The structure of LTP supports all transport protocols including\ + \ circuit and packet forms." + tapi.common.ServiceInterfacePointRef: + type: "object" + properties: + service-interface-point-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-common:service-interface-point/tapi-common:uuid" + tapi.common.TapiContext: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + service-interface-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + description: "The Network Control Domain (NCD) object class represents the scope\ + \ of control that a particular SDN controller has with respect to a particular\ + \ network, (i.e., encompassing a designated set of interconnected (virtual)\ + \ network elements)." + tapi.common.TerminationDirection: + type: "string" + enum: + - "BIDIRECTIONAL" + - "SINK" + - "SOURCE" + - "UNDEFINED_OR_UNKNOWN" + tapi.common.TerminationPac: + type: "object" + properties: + termination-direction: + description: "The overall directionality of the LP. \r\n -\ + \ A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ + \ - A SINK LP can only contain elements with SINK flows or CONTRA_DIRECTION_SOURCE\ + \ flows\r\n - A SOURCE LP can only contain SOURCE flows or\ + \ CONTRA_DIRECTION_SINK flows" + $ref: "#/definitions/tapi.common.TerminationDirection" + termination-state: + description: "Indicates whether the layer is terminated and if so how." + $ref: "#/definitions/tapi.common.TerminationState" + tapi.common.TerminationState: + type: "string" + enum: + - "LP_CAN_NEVER_TERMINATE" + - "LT_NOT_TERMINATED" + - "TERMINATED_SERVER_TO_CLIENT_FLOW" + - "TERMINATED_CLIENT_TO_SERVER_FLOW" + - "TERMINATED_BIDIRECTIONAL" + - "LT_PERMENANTLY_TERMINATED" + - "TERMINATION_STATE_UNKNOWN" + tapi.common.TimeInterval: + type: "object" + properties: + period: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.TimePeriod" + tapi.common.TimePeriod: + type: "object" + properties: + value: + type: "integer" + format: "int32" + description: "none" + unit: + description: "none" + $ref: "#/definitions/tapi.common.TimeUnit" + tapi.common.TimeRange: + type: "object" + properties: + end-time: + type: "string" + description: "none" + start-time: + type: "string" + description: "none" + tapi.common.TimeUnit: + type: "string" + enum: + - "YEARS" + - "MONTHS" + - "DAYS" + - "HOURS" + - "MINUTES" + - "SECONDS" + - "MILLISECONDS" + - "MICROSECONDS" + - "NANOSECONDS" + - "PICOSECONDS" + tapi.common.getserviceinterfacepointdetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.common.getserviceinterfacepointdetails.Output: + type: "object" + properties: + sip: + description: "none" + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + tapi.common.getserviceinterfacepointlist.Output: + type: "object" + properties: + sip: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + tapi.common.updateserviceinterfacepoint.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + tapi.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" + bounding-node: + description: "none" + $ref: "#/definitions/tapi.topology.NodeRef" + 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: + protection-role: + description: "none" + $ref: "#/definitions/tapi.connectivity.ProtectionRole" + 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" + 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:node-edge-point/tapi-connectivity:cep-list/tapi-connectivity:connection-end-point/tapi-connectivity:uuid" + description: "none" + 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.ConnectivityConstraint: + type: "object" + properties: + schedule: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + requested-capacity: + description: "none" + $ref: "#/definitions/tapi.common.Capacity" + diversity-exclusion: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + 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\r\n Class of Service Name." + service-type: + description: "none" + $ref: "#/definitions/tapi.connectivity.ServiceType" + coroute-inclusion: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + tapi.connectivity.ConnectivityContext: + type: "object" + properties: + connectivity-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectivityService" + connection: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.Connection" + tapi.connectivity.ConnectivityService: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + connection: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "The ForwardingConstruct (FC) object class models enabled potential\ + \ for forwarding between two or more LTPs and like the LTP supports any transport\ + \ protocol including all circuit and packet forms.\r\n At the lowest\ + \ level of recursion, a FC represents a cross-connection within an NE." + 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" + direction: + description: "The orientation of defined flow at the EndPoint." + $ref: "#/definitions/tapi.common.PortDirection" + capacity: + description: "none" + $ref: "#/definitions/tapi.common.Capacity" + protecting-connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + description: "The association of the FC to LTPs is made via EndPoints.\r\n \ + \ The EndPoint (EP) object class models the access to the FC function.\ + \ \r\n The traffic forwarding between the associated EPs of the\ + \ FC depends upon the type of FC and may be associated with FcSwitch object\ + \ instances. \r\n In cases where there is resilience the EndPoint\ + \ may convey the resilience role of the access to the FC. \r\n \ + \ It can represent a protected (resilient/reliable) point or a protecting\ + \ (unreliable working or protection) point.\r\n The EP replaces\ + \ the Protection Unit of a traditional protection model. \r\n The\ + \ ForwadingConstruct can be considered as a component and the EndPoint as\ + \ a Port on that component" + tapi.connectivity.ConnectivityServiceEndPointRef: + allOf: + - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + - type: "object" + properties: + connectivity-service-end-point-local-id: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-connectivity:connectivity-context/tapi-connectivity:connectivity-service/tapi-connectivity:end-point/tapi-connectivity:local-id" + description: "none" + tapi.connectivity.ConnectivityServiceRef: + type: "object" + properties: + 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.ContextAugmentation4: + 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.NodeEdgePointAugmentation2: + type: "object" + properties: + cep-list: + description: "none" + $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.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." + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" + hold-off-time: + type: "integer" + format: "int32" + description: "This attribute indicates the time, in milliseconds, between\ + \ declaration of signal degrade or signal fail, and the initialization of\ + \ the protection switching algorithm." + 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 + selection-control: + description: "Degree of administrative control applied to the switch selection." + $ref: "#/definitions/tapi.connectivity.SelectionControl" + preferred-restoration-layer: + type: "array" + description: "Indicate which layer this resilience parameters package configured\ + \ for." + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + restore-priority: + type: "integer" + format: "int32" + description: "none" + restoration-policy: + description: "none" + $ref: "#/definitions/tapi.topology.RestorationPolicy" + restoration-coordinate-type: + description: " The coordination mechanism between multi-layers." + $ref: "#/definitions/tapi.connectivity.CoordinateType" + is-coordinated-switching-both-ends: + type: "boolean" + description: "Is operating such that switching at both ends of each flow acorss\ + \ the FC is coordinated at both ingress and egress ends." + default: false + fault-condition-determination: + type: "string" + description: "none" + is-frozen: + type: "boolean" + description: "Temporarily prevents any switch action to be taken and, as such,\ + \ freezes the current state. \r\n Until the freeze is cleared,\ + \ additional near-end external commands are rejected and fault condition\ + \ changes and received APS messages are ignored.\r\n All\ + \ administrative controls of any aspect of protection are rejected." + default: false + reversion-mode: + description: "Indcates whether the protection scheme is revertive or non-revertive." + $ref: "#/definitions/tapi.connectivity.ReversionMode" + 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" + description: "The FC Route (FcRoute) object class models the individual routes\ + \ of an FC. \r\n The route of an FC object is represented by a\ + \ list of FCs at a lower level. \r\n Note that depending on the\ + \ service supported by an FC, an the FC can have multiple routes." + 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.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-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.UpdateConnectivityService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.connectivity.updateconnectivityservice.Output" + tapi.connectivity.ceplist.ConnectionEndPoint: + allOf: + - $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" + - $ref: "#/definitions/tapi.oam.ConnectionEndPointAugmentation1" + - $ref: "#/definitions/tapi.odu.ConnectionEndPointAugmentation2" + tapi.connectivity.connectivitycontext.ConnectivityService: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + connection: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "none" + tapi.connectivity.connectivityservice.EndPoint: + allOf: + - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + - $ref: "#/definitions/tapi.odu.EndPointAugmentation1" + tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList: + allOf: + - type: "object" + properties: + connection-end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" + description: "none" + tapi.connectivity.createconnectivityservice.Input: + type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.createconnectivityservice.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityService" + tapi.connectivity.deleteconnectivityservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.getconnectiondetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.getconnectiondetails.Output: + type: "object" + properties: + connection: + description: "none" + $ref: "#/definitions/tapi.connectivity.Connection" + tapi.connectivity.getconnectionendpointdetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.getconnectionendpointdetails.Output: + type: "object" + properties: + connection-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" + tapi.connectivity.getconnectivityservicedetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.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: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.updateconnectivityservice.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityService" + tapi.notification.ContextAugmentation1: + type: "object" + properties: + notification-context: + description: "Augments the base TAPI Context with NotificationService information" + $ref: "#/definitions/tapi.notification.context.NotificationContext" + x-augmentation: + prefix: "tapi-notification" + namespace: "urn:onf:otcc:yang:tapi-notification" + tapi.notification.CreateNotificationSubscriptionService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Output" + tapi.notification.GetNotificationList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationlist.Output" + tapi.notification.GetNotificationSubscriptionServiceDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Output" + tapi.notification.GetNotificationSubscriptionServiceList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicelist.Output" + tapi.notification.GetSupportedNotificationTypes: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getsupportednotificationtypes.Output" + tapi.notification.NameAndValueChange: + type: "object" + properties: + value-name: + type: "string" + description: "The name of the value. The value need not have a name." + old-value: + type: "string" + description: "The value" + new-value: + type: "string" + description: "The value" + tapi.notification.Notification: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + target-object-type: + type: "string" + description: "none" + additional-text: + type: "string" + description: "none" + event-time-stamp: + type: "string" + description: "none" + additional-info: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.NameAndValue" + sequence-number: + type: "integer" + format: "int32" + description: "A monotonous increasing sequence number associated with the\ + \ notification.\r\n The exact semantics of how this sequence\ + \ number is assigned (per channel or subscription or source or system)\ + \ is left undefined." + target-object-identifier: + type: "string" + description: "none" + notification-type: + type: "string" + description: "none" + target-object-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.NameAndValue" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + source-indicator: + description: "none" + $ref: "#/definitions/tapi.notification.SourceIndicator" + layer-protocol-qualifier: + type: "string" + description: "none" + changed-attributes: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + description: "none" + tapi.notification.NotificationChannel: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + next-sequence-no: + type: "integer" + format: "int32" + description: "The sequence number of the next notification that will be\ + \ published on the channel" + stream-address: + type: "string" + description: "The address/location/URI of the channel/stream to which the\ + \ subscribed notifications are published.\r\n This specifics\ + \ of this is typically dependent on the implementation protocol & mechanism\ + \ and hence is typed as a string." + description: "none" + tapi.notification.NotificationSubscriptionService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.Notification" + notification-channel: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationChannel" + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + supported-object-types: + type: "array" + description: "none" + items: + type: "string" + supported-notification-types: + type: "array" + description: "none" + items: + type: "string" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + description: "none" + tapi.notification.SourceIndicator: + type: "string" + enum: + - "RESOURCE_OPERATION" + - "MANAGEMENT_OPERATION" + - "UNKNOWN" + tapi.notification.SubscriptionFilter: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + requested-notification-types: + type: "array" + description: "none" + items: + type: "string" + requested-object-identifier: + type: "array" + description: "none" + items: + type: "string" + requested-layer-protocols: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + include-content: + type: "boolean" + description: "Indicates whether the published Notification includes content\ + \ or just the Notification Id (which enables retrieval of the notification\ + \ at the later stage)" + default: false + requested-object-types: + type: "array" + description: "none" + items: + type: "string" + description: "none" + tapi.notification.SubscriptionState: + type: "string" + enum: + - "SUSPENDED" + - "ACTIVE" + tapi.notification.UpdateNotificationSubscriptionService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Output" + tapi.notification.context.NotificationContext: + allOf: + - type: "object" + properties: + notif-subscription: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" + description: "Augments the base TAPI Context with NotificationService information" + tapi.notification.createnotificationsubscriptionservice.Input: + type: "object" + properties: + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + tapi.notification.createnotificationsubscriptionservice.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.deletenotificationsubscriptionservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationlist.Input: + type: "object" + properties: + time-range: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + subscription-id: + type: "string" + description: "UUID of the associated Notification Subscription Service: An\ + \ identifier that is universally unique within an identifier space, where\ + \ the identifier space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationlist.Output: + type: "object" + properties: + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" + tapi.notification.getnotificationsubscriptionservicedetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationsubscriptionservicedetails.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.getnotificationsubscriptionservicelist.Output: + type: "object" + properties: + subscription-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.getsupportednotificationtypes.Output: + type: "object" + properties: + supported-object-types: + type: "array" + description: "none" + items: + type: "string" + supported-notification-types: + type: "array" + description: "none" + items: + type: "string" + tapi.notification.notificationcontext.Notification: + allOf: + - $ref: "#/definitions/tapi.notification.Notification" + - $ref: "#/definitions/tapi.oam.NotificationAugmentation1" + - $ref: "#/definitions/tapi.oam.NotificationAugmentation2" + tapi.notification.updatenotificationsubscriptionservice.Input: + type: "object" + properties: + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + tapi.notification.updatenotificationsubscriptionservice.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.oam.AlarmInfo: + type: "object" + properties: + perceived-severity: + description: "none" + $ref: "#/definitions/tapi.oam.PerceivedSeverityType" + probable-cause: + type: "string" + description: "none" + service-affecting: + description: "none" + $ref: "#/definitions/tapi.oam.ServiceAffecting" + is-transient: + type: "boolean" + description: "none" + default: false + tapi.oam.ConnectionEndPointAugmentation1: + type: "object" + properties: + mep-mip-list: + description: "none" + $ref: "#/definitions/tapi.oam.MepMipList" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" + tapi.oam.ContextAugmentation3: + type: "object" + properties: + oam-context: + description: "Augments the base TAPI Context with OamService information" + $ref: "#/definitions/tapi.oam.context.OamContext" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" + tapi.oam.CreateOamJob: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.createoamjob.Output" + tapi.oam.CreateOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.createoamprofile.Output" + tapi.oam.CreateOamService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.createoamservice.Output" + tapi.oam.CreateOamServicePoint: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.createoamservicepoint.Output" + tapi.oam.CurrentData: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + elapsed-time: + description: "none" + $ref: "#/definitions/tapi.common.TimeInterval" + period-start-time: + type: "string" + description: "This attribute indicates the start of the current monitoring\ + \ interval.\r\n The value is bound to the quarter of an\ + \ hour in case of a 15 minute interval and bound to the hour in case of\ + \ a 24 hour interval." + pm-data-pac: + description: "none" + $ref: "#/definitions/tapi.oam.PmDataPac" + history-data: + type: "array" + description: "in case of 24hr Current Data, at least 1 History Data.\r\n\ + \ In case of 15min Current Data, at least 16 History Data.\r\ + \n In case of <15min, the number of History Data shall\ + \ be able to cover a span of 4 hours." + items: + $ref: "#/definitions/tapi.oam.HistoryData" + description: "none" + tapi.oam.GetMeg: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getmeg.Output" + tapi.oam.GetOamJob: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamjob.Output" + tapi.oam.GetOamJobList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamjoblist.Output" + tapi.oam.GetOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamprofile.Output" + tapi.oam.GetOamProfileList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamprofilelist.Output" + tapi.oam.GetOamService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamservice.Output" + tapi.oam.GetOamServiceList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamservicelist.Output" + tapi.oam.GetOamServicePoint: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamservicepoint.Output" + tapi.oam.HistoryData: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + period-start-time: + type: "string" + description: "This attribute indicates the start of the monitoring interval.\r\ + \n The value is bound to the quarter of an hour in case\ + \ of a 15 minute interval and bound to the hour in case of a 24 hour interval." + pm-data-pac: + description: "none" + $ref: "#/definitions/tapi.oam.PmDataPac" + period-end-time: + type: "string" + description: "none" + description: "none" + tapi.oam.Meg: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.common.OperationalStatePac" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + mep: + type: "array" + description: "1. ME may have 0 MEPs (case of transit domains where at least\ + \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case of edge\ + \ domaind, where the peer MEP is ouside the managed domain)\r\n \ + \ 3. ME may have 2 MEPs" + items: + $ref: "#/definitions/tapi.oam.Mep" + mip: + type: "array" + description: "ME may 0, 1, or more MIPs" + items: + $ref: "#/definitions/tapi.oam.Mip" + description: "none" + tapi.oam.MegRef: + type: "object" + properties: + meg-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:uuid" + tapi.oam.Mep: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - $ref: "#/definitions/tapi.common.OperationalStatePac" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + description: "none" + tapi.oam.MepMipList: + type: "object" + properties: + mip: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.MipRef" + mep: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.MepRef" + tapi.oam.MepRef: + allOf: + - $ref: "#/definitions/tapi.oam.MegRef" + - type: "object" + properties: + mep-local-id: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:mep/tapi-oam:local-id" + description: "none" + tapi.oam.Mip: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + description: "none" + tapi.oam.MipRef: + allOf: + - $ref: "#/definitions/tapi.oam.MegRef" + - type: "object" + properties: + mip-local-id: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:mip/tapi-oam:local-id" + description: "none" + tapi.oam.NotificationAugmentation1: + type: "object" + properties: + tca-info: + description: "none" + $ref: "#/definitions/tapi.oam.TcaInfo" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" + tapi.oam.NotificationAugmentation2: + type: "object" + properties: + alarm-info: + description: "none" + $ref: "#/definitions/tapi.oam.AlarmInfo" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" + tapi.oam.OamJob: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + schedule: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + oam-profile: + description: "none" + $ref: "#/definitions/tapi.oam.OamProfileRef" + creation-time: + type: "string" + description: "none" + oam-job-type: + type: "string" + description: "none" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamServicePointRef" + current-data: + type: "array" + description: "Granularity period of the CurrentData identifies the specific\ + \ CurrentData instance in the scope of this OamJob.\r\n \ + \ For example, typically at least\r\n one 15min and\r\n\ + \ one 24hr;\r\n optionally one additional\ + \ configurable (< 15min)" + items: + $ref: "#/definitions/tapi.oam.CurrentData" + description: "none" + tapi.oam.OamJobRef: + type: "object" + properties: + oam-job-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-job/tapi-oam:uuid" + tapi.oam.OamProfile: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + pm-threshold-data: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.PmThresholdData" + description: "none" + tapi.oam.OamProfileRef: + type: "object" + properties: + oam-profile-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-profile/tapi-oam:uuid" + tapi.oam.OamService: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamServicePoint" + meg: + description: "none" + $ref: "#/definitions/tapi.oam.MegRef" + description: "none" + tapi.oam.OamServicePoint: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + mip: + description: "none" + $ref: "#/definitions/tapi.oam.MipRef" + service-interface-point: + description: "none" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + is-mip: + type: "boolean" + description: "If true, the object is related to a MIP.\r\n \ + \ If false, the object is related to a MEP." + default: false + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + mep: + description: "none" + $ref: "#/definitions/tapi.oam.MepRef" + description: "none" + tapi.oam.OamServicePointRef: + allOf: + - $ref: "#/definitions/tapi.oam.OamServiceRef" + - type: "object" + properties: + oam-service-point-local-id: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:oam-service-point/tapi-oam:local-id" + description: "none" + tapi.oam.OamServiceRef: + type: "object" + properties: + oam-service-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:uuid" + tapi.oam.PerceivedSeverityType: + type: "string" + enum: + - "CRITICAL" + - "MAJOR" + - "MINOR" + - "WARNING" + - "CLEARED" + tapi.oam.PerceivedTcaSeverity: + type: "string" + enum: + - "WARNING" + - "CLEAR" + tapi.oam.PmDataPac: + type: "object" + properties: + suspect-interval-flag: + type: "boolean" + description: "This attribute is used to indicate that the performance data\ + \ for the current period may not be reliable. Some reasons for this to occur\ + \ are:\r\n – Suspect data were detected by the actual resource\ + \ doing data collection.\r\n – Transition of the administrativeState\ + \ attribute to/from the 'lock' state.\r\n – Transition of\ + \ the operationalState to/from the 'disabled' state.\r\n \ + \ – Scheduler setting that inhibits the collection function.\r\n \ + \ – The performance counters were reset during the interval.\r\n\ + \ – The currentData (or subclass) object instance was created\ + \ during the monitoring period." + default: false + granularity-period: + description: "none" + $ref: "#/definitions/tapi.common.TimePeriod" + tapi.oam.PmParameterValue: + type: "object" + properties: + pm-parameter-int-value: + type: "integer" + format: "int32" + description: "none" + pm-parameter-real-value: + type: "string" + description: "none" + tapi.oam.PmThresholdData: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + granularity-period: + description: "none" + $ref: "#/definitions/tapi.common.TimePeriod" + threshold-parameter: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.ThresholdParameter" + is-transient: + type: "boolean" + description: "none" + default: false + applicable-job-type: + type: "array" + description: "This attribute allows an PMThresholdData instance to be constrained\ + \ to specific job types. If an PMThresholdData instance is so configured\ + \ to be applicable to more than one job type (worst case ALL), only the\ + \ parameters relevant for the job instance will be used (non-applicable\ + \ profile parameters will be ignored)" + items: + type: "string" + description: "none" + tapi.oam.ServiceAffecting: + type: "string" + enum: + - "SERVICE_AFFECTING" + - "NOT_SERVICE_AFFECTING" + - "UNKNOWN" + tapi.oam.TcaInfo: + type: "object" + properties: + oam-job: + description: "MEF 35.1\r\n Identification of the PM Session\ + \ for which the TCA Function was configured." + $ref: "#/definitions/tapi.oam.OamJobRef" + threshold-parameter: + description: "none" + $ref: "#/definitions/tapi.oam.ThresholdParameter" + is-transient: + type: "boolean" + description: "none" + default: false + perceived-severity: + description: "none" + $ref: "#/definitions/tapi.oam.PerceivedTcaSeverity" + suspect-interval-flag: + type: "boolean" + description: "none" + default: false + measurement-interval: + type: "string" + description: "none" + tapi.oam.ThresholdCrossingQualifier: + type: "string" + enum: + - "NOT_APPLICABLE" + - "NEAR_END" + - "FAR_END" + - "BIDIRECTIONAL" + - "FORWARD" + - "BACKWARD" + tapi.oam.ThresholdParameter: + type: "object" + properties: + pm-parameter-below-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-clear-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-above-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-name: + type: "string" + description: "none" + threshold-location: + description: "none" + $ref: "#/definitions/tapi.oam.ThresholdCrossingQualifier" + tapi.oam.UpdateOamJob: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.updateoamjob.Output" + tapi.oam.UpdateOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.updateoamprofile.Output" + tapi.oam.UpdateOamService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.updateoamservice.Output" + tapi.oam.UpdateOamServicePoint: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.updateoamservicepoint.Output" + tapi.oam.context.OamContext: + allOf: + - type: "object" + properties: + oam-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamService" + oam-profile: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamProfile" + oam-job: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamJob" + meg: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.oamcontext.Meg" + description: "Augments the base TAPI Context with OamService information" + tapi.oam.createoamjob.Input: + type: "object" + properties: + schedule: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point-id: + type: "string" + description: "UUID of the associated OSEPs: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + oam-job-type: + type: "string" + description: "none" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + oam-profile-id: + type: "string" + description: "UUID of the OamProfile to be applied: An identifier that is\ + \ universally unique within an identifier space, where the identifier space\ + \ is itself globally unique, and immutable.\r\n An UUID\ + \ carries no semantics with respect to the purpose or state of the entity.\r\ + \n UUID here uses string representation as defined in\ + \ RFC 4122. The canonical representation uses lowercase characters.\r\n\ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + oam-service-id: + type: "string" + description: "UUID of the associated OamService: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.createoamjob.Output: + type: "object" + properties: + oam-job: + description: "none" + $ref: "#/definitions/tapi.oam.OamJob" + tapi.oam.createoamprofile.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + pm-threshold-data: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.PmThresholdData" + tapi.oam.createoamprofile.Output: + type: "object" + properties: + oam-profile: + description: "none" + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.createoamservice.Input: + type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamServicePoint" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.createoamservice.Output: + type: "object" + properties: + oam-service: + description: "none" + $ref: "#/definitions/tapi.oam.OamService" + tapi.oam.createoamservicepoint.Input: + type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + connectivity-service-end-point-id: + type: "string" + description: "UUID of the CSEP to be monitored: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + service-interface-point-id: + type: "string" + description: "UUID of the associated SIP to be monitored: An identifier that\ + \ is universally unique within an identifier space, where the identifier\ + \ space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose or state of\ + \ the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + oam-service-id: + type: "string" + description: "UUID of the parent OamService: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.createoamservicepoint.Output: + type: "object" + properties: + oam-service-point: + description: "none" + $ref: "#/definitions/tapi.oam.OamServicePoint" + tapi.oam.deleteoamjob.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamprofile.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamservicepoint.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getmeg.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getmeg.Output: + type: "object" + properties: + meg: + description: "none" + $ref: "#/definitions/tapi.oam.Meg" + tapi.oam.getoamjob.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamjob.Output: + type: "object" + properties: + oam-job: + description: "none" + $ref: "#/definitions/tapi.oam.OamJob" + tapi.oam.getoamjoblist.Output: + type: "object" + properties: + oam-job: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamJob" + tapi.oam.getoamprofile.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamprofile.Output: + type: "object" + properties: + oam-profile: + description: "none" + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.getoamprofilelist.Output: + type: "object" + properties: + oam-profile: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.getoamservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamservice.Output: + type: "object" + properties: + oam-service: + description: "none" + $ref: "#/definitions/tapi.oam.OamService" + tapi.oam.getoamservicelist.Output: + type: "object" + properties: + oam-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamService" + tapi.oam.getoamservicepoint.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamservicepoint.Output: + type: "object" + properties: + oam-service-point: + description: "none" + $ref: "#/definitions/tapi.oam.OamServicePoint" + tapi.oam.meg.Mep: + allOf: + - $ref: "#/definitions/tapi.oam.Mep" + - $ref: "#/definitions/tapi.odu.MepAugmentation1" + tapi.oam.meg.Mip: + allOf: + - $ref: "#/definitions/tapi.oam.Mip" + - $ref: "#/definitions/tapi.odu.MipAugmentation1" + tapi.oam.oamcontext.Meg: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.common.OperationalStatePac" + - $ref: "#/definitions/tapi.odu.MegAugmentation1" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + mep: + type: "array" + description: "1. ME may have 0 MEPs (case of transit domains where at least\ + \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case of edge\ + \ domaind, where the peer MEP is ouside the managed domain)\r\n \ + \ 3. ME may have 2 MEPs" + items: + $ref: "#/definitions/tapi.oam.meg.Mep" + mip: + type: "array" + description: "ME may 0, 1, or more MIPs" + items: + $ref: "#/definitions/tapi.oam.meg.Mip" + description: "none" + tapi.oam.updateoamjob.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + schedule: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + oam-profile-id: + type: "string" + description: "UUID of the OamProfile to be applied: An identifier that is\ + \ universally unique within an identifier space, where the identifier space\ + \ is itself globally unique, and immutable.\r\n An UUID\ + \ carries no semantics with respect to the purpose or state of the entity.\r\ + \n UUID here uses string representation as defined in\ + \ RFC 4122. The canonical representation uses lowercase characters.\r\n\ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.updateoamjob.Output: + type: "object" + properties: + oam-job: + description: "none" + $ref: "#/definitions/tapi.oam.OamJob" + tapi.oam.updateoamprofile.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + pm-threshold-data: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.PmThresholdData" + tapi.oam.updateoamprofile.Output: + type: "object" + properties: + oam-profile: + description: "none" + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.updateoamservice.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamServicePoint" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.updateoamservice.Output: + type: "object" + properties: + oam-service: + description: "none" + $ref: "#/definitions/tapi.oam.OamService" + tapi.oam.updateoamservicepoint.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.updateoamservicepoint.Output: + type: "object" + properties: + oam-service-point: + description: "none" + $ref: "#/definitions/tapi.oam.OamServicePoint" + tapi.odu.ConnectionEndPointAugmentation2: + type: "object" + properties: + odu-connection-end-point-spec: + description: "none" + $ref: "#/definitions/tapi.odu.OduConnectionEndPointSpec" + x-augmentation: + prefix: "tapi-odu" + namespace: "urn:onf:otcc:yang:tapi-odu" + tapi.odu.DegThr: + type: "object" + properties: + deg-thr-value: + type: "integer" + format: "int32" + description: "Percentage of detected errored blocks" + percentage-granularity: + description: "none" + $ref: "#/definitions/tapi.odu.PercentageGranularity" + deg-thr-type: + description: "Number of errored blocks" + $ref: "#/definitions/tapi.odu.DegThrType" + tapi.odu.DegThrType: + type: "string" + enum: + - "PERCENTAGE" + - "NUMBER_ERRORED_BLOCKS" + tapi.odu.EndPointAugmentation1: + type: "object" + properties: + odu-connectivity-service-end-point-spec: + description: "none" + $ref: "#/definitions/tapi.odu.OduConnectivityServiceEndPointSpec" + x-augmentation: + prefix: "tapi-odu" + namespace: "urn:onf:otcc:yang:tapi-odu" + tapi.odu.MappingType: + type: "string" + enum: + - "AMP" + - "BMP" + - "GFP-F" + - "GMP" + - "TTP_GFP_BMP" + - "NULL" + tapi.odu.MegAugmentation1: + type: "object" + properties: + odu-meg-spec: + description: "none" + $ref: "#/definitions/tapi.odu.OduMegSpec" + x-augmentation: + prefix: "tapi-odu" + namespace: "urn:onf:otcc:yang:tapi-odu" + tapi.odu.MepAugmentation1: + type: "object" + properties: + odu-mep-spec: + description: "none" + $ref: "#/definitions/tapi.odu.OduMepSpec" + x-augmentation: + prefix: "tapi-odu" + namespace: "urn:onf:otcc:yang:tapi-odu" + tapi.odu.MipAugmentation1: + type: "object" + properties: + odu-mip-spec: + description: "none" + $ref: "#/definitions/tapi.odu.OduMipSpec" + x-augmentation: + prefix: "tapi-odu" + namespace: "urn:onf:otcc:yang:tapi-odu" + tapi.odu.NodeEdgePointAugmentation1: + type: "object" + properties: + odu-node-edge-point-spec: + description: "Augments the base LayerProtocol information in NodeEdgePoint\ + \ with ODU-specific information" + $ref: "#/definitions/tapi.odu.OduNodeEdgePointSpec" + x-augmentation: + prefix: "tapi-odu" + namespace: "urn:onf:otcc:yang:tapi-odu" + tapi.odu.OduCommonPac: + type: "object" + properties: + odu-rate-tolerance: + type: "integer" + format: "int32" + description: "This attribute indicates the rate tolerance of the ODU termination\ + \ point. \r\n Valid values are real value in the unit of\ + \ ppm. \r\n Standardized values are defined in Table 7-2/G.709." + odu-rate: + type: "integer" + format: "int32" + description: "This attribute indicates the rate of the ODU terminatino point.\ + \ \r\n This attribute is Set at create; i.e., once created\ + \ it cannot be changed directly. \r\n In case of resizable\ + \ ODU flex, its value can be changed via HAO (not directly on the attribute).\ + \ \r\n " + odu-type: + type: "string" + description: "This attribute specifies the type of the ODU termination point." + tapi.odu.OduConnectionEndPointSpec: + type: "object" + properties: + odu-term-and-adapter: + description: "none" + $ref: "#/definitions/tapi.odu.OduTerminationAndClientAdaptationPac" + odu-common: + description: "none" + $ref: "#/definitions/tapi.odu.OduCommonPac" + odu-ctp: + description: "none" + $ref: "#/definitions/tapi.odu.OduCtpPac" + odu-protection: + description: "none" + $ref: "#/definitions/tapi.odu.OduProtectionPac" + tapi.odu.OduConnectivityServiceEndPointSpec: + type: "object" + properties: + accepted-payload-type: + description: "This attribute is applicable when the ODU CTP object instance\ + \ represents a lower order ODU CTP Sink at the client layer of the ODUP/ODU[i]j\ + \ or ODUP/ODUj-21 adaptation function. \r\n This attribute\ + \ is a 2-digit Hex code that indicates the new accepted payload type.\r\n\ + \ Valid values are defined in Table 15-8 of ITU-T Recommendation\ + \ G.709 with one additional value UN_INTERPRETABLE." + $ref: "#/definitions/tapi.odu.OduPayloadType" + opu-tributary-slot-size: + description: "This attribute is applicable for ODU2 and ODU3 CTP only. It\ + \ indicates the slot size of the ODU CTP." + $ref: "#/definitions/tapi.odu.OduSlotSize" + tributary-port-number: + type: "integer" + format: "int32" + description: "This attribute identifies the tributary port number that is\ + \ associated with the ODU CTP.\r\n range of type : The value\ + \ range depends on the size of the Tributary Port Number (TPN) field used\ + \ which depends on th server-layer ODU or OTU.\r\n In case\ + \ of ODUk mapping into OTUk, there is no TPN field, so the tributaryPortNumber\ + \ shall be zero.\r\n In case of LO ODUj mapping over ODU1,\ + \ ODU2 or ODU3, the TPN is encoded in a 6-bit field so the value range is\ + \ 0-63. See clause 14.4.1/G.709-2016.\r\n In case of LO ODUj\ + \ mapping over ODU4, the TPN is encoded in a 7-bit field so the value range\ + \ is 0-127. See clause 14.4.1.4/G.709-2016.\r\n In case of\ + \ ODUk mapping over ODUCn, the TPN is encoded in a 14-bit field so the value\ + \ range is 0-16383. See clause 20.4.1.1/G.709-2016.\r\n " + tributary-slot-list: + type: "array" + description: "This attribute contains a set of distinct (i.e. unique) integers\ + \ (e.g. 2, 3, 5, 9, 15 representing the tributary slots TS2, TS3, TS5, TS9\ + \ and TS15) which represents the resources occupied by the Low Order ODU\ + \ Link Connection (e.g. carrying an ODUflex with a bit rate of 6.25G). \r\ + \n This attribute applies when the LO ODU_ ConnectionTerminationPoint\ + \ connects with an HO ODU_TrailTerminationPoint object. \r\n \ + \ It will not apply if this ODU_ ConnectionTerminationPoint object directly\ + \ connects to an OTU_TrailTerminationPoint object (i.e. OTU has no trib\ + \ slots). \r\n The upper bound of the integer allowed in\ + \ this set is a function of the HO-ODU server layer to which the ODU connection\ + \ has been mapped (adapted). \r\n Thus, for example, M=8/32/80\ + \ for ODU2/ODU3/ODU4 server layers (respectively). Note that the value of\ + \ this attribute can be changed only in the case of ODUflex and has to be\ + \ through specific operations (i.e. not be changing the attribute tributarySlotList\ + \ directly)." + items: + type: "integer" + format: "int32" + configured-mapping-type: + description: "This attributes indicates the configured mapping type." + $ref: "#/definitions/tapi.odu.MappingType" + odu-type: + type: "string" + description: "This attribute specifies the type of the ODU termination point." + tapi.odu.OduCtpPac: + type: "object" + properties: + accepted-msi: + type: "string" + description: "This attribute is applicable when the ODU CTP object instance\ + \ represents a lower order ODU1 or ODU2 CTP Sink at the client layer of\ + \ the ODU3P/ODU12 adaptation function or represents a lower order ODUj CTP\ + \ Sink at the client layer of the ODUP/ODUj-21 adaptation function. This\ + \ attribute is a 1-byte field that represents the accepted multiplex structure\ + \ of the adaptation function. " + tributary-port-number: + type: "integer" + format: "int32" + description: "This attribute identifies the tributary port number that is\ + \ associated with the ODU CTP.\r\n range of type : The value\ + \ range depends on the size of the Tributary Port Number (TPN) field used\ + \ which depends on th server-layer ODU or OTU.\r\n In case\ + \ of ODUk mapping into OTUk, there is no TPN field, so the tributaryPortNumber\ + \ shall be zero.\r\n In case of LO ODUj mapping over ODU1,\ + \ ODU2 or ODU3, the TPN is encoded in a 6-bit field so the value range is\ + \ 0-63. See clause 14.4.1/G.709-2016.\r\n In case of LO ODUj\ + \ mapping over ODU4, the TPN is encoded in a 7-bit field so the value range\ + \ is 0-127. See clause 14.4.1.4/G.709-2016.\r\n In case of\ + \ ODUk mapping over ODUCn, the TPN is encoded in a 14-bit field so the value\ + \ range is 0-16383. See clause 20.4.1.1/G.709-2016.\r\n " + tributary-slot-list: + type: "array" + description: "This attribute contains a set of distinct (i.e. unique) integers\ + \ (e.g. 2, 3, 5, 9, 15 representing the tributary slots TS2, TS3, TS5, TS9\ + \ and TS15) which represents the resources occupied by the Low Order ODU\ + \ Link Connection (e.g. carrying an ODUflex with a bit rate of 6.25G). \r\ + \n This attribute applies when the LO ODU_ ConnectionTerminationPoint\ + \ connects with an HO ODU_TrailTerminationPoint object. \r\n \ + \ It will not apply if this ODU_ ConnectionTerminationPoint object directly\ + \ connects to an OTU_TrailTerminationPoint object (i.e. OTU has no trib\ + \ slots). \r\n The upper bound of the integer allowed in\ + \ this set is a function of the HO-ODU server layer to which the ODU connection\ + \ has been mapped (adapted). \r\n Thus, for example, M=8/32/80\ + \ for ODU2/ODU3/ODU4 server layers (respectively). Note that the value of\ + \ this attribute can be changed only in the case of ODUflex and has to be\ + \ through specific operations (i.e. not be changing the attribute tributarySlotList\ + \ directly)." + items: + type: "integer" + format: "int32" + tapi.odu.OduDefectPac: + type: "object" + properties: + oci: + type: "boolean" + description: "Open Connection Indicator" + default: false + lck: + type: "boolean" + description: "Locked" + default: false + bdi: + type: "boolean" + description: "Backward Defect Indication" + default: false + ssf: + type: "boolean" + description: "Server Signal Failure" + default: false + deg: + type: "boolean" + description: "Signal Degraded" + default: false + tim: + type: "boolean" + description: "Trail Trace Identifier Mismatch" + default: false + tapi.odu.OduMegSpec: + type: "object" + properties: + meg-level: + type: "integer" + format: "int32" + description: "none" + tapi.odu.OduMepPac: + allOf: + - $ref: "#/definitions/tapi.odu.OduMipPac" + - type: "object" + properties: + dm-source: + type: "boolean" + description: "This attribute is for configuring the delay measurement process\ + \ at the trail termination function represented by the subject TTP object\ + \ class. It models the MI_DM_Source MI signal. If MI_DM_Source is false,\ + \ then the value of the DMp bit is determined by the RI_DM. If MI_DM_Source\ + \ is true, then the value of the DMp bit is set to MI_DMValue." + default: false + dm-value: + type: "boolean" + description: "This attribute is for setting the DMp and DMti bits of the\ + \ delay measurement process. The value of 'true' sets the DMp and DMti\ + \ bits to 0 and the value of 'false' to 1." + default: false + txti: + type: "string" + description: "The Trail Trace Identifier (TTI) information, provisioned\ + \ by the managing system at the termination source, to be placed in the\ + \ TTI overhead position of the source of a trail for transmission.\r\n\ + \ " + description: "none" + tapi.odu.OduMepSpec: + type: "object" + properties: + odu-pm: + description: "none" + $ref: "#/definitions/tapi.odu.OduPmPac" + odu-ncm: + description: "none" + $ref: "#/definitions/tapi.odu.OduNcmPac" + odu-mep: + description: "none" + $ref: "#/definitions/tapi.odu.OduMepPac" + odu-tcm: + description: "none" + $ref: "#/definitions/tapi.odu.OduTcmMepPac" + odu-defect: + description: "none" + $ref: "#/definitions/tapi.odu.OduDefectPac" + tapi.odu.OduMipPac: + type: "object" + properties: + tim-det-mode: + description: "This attribute indicates the mode of the Trace Identifier Mismatch\ + \ (TIM) Detection function allowed values: OFF, SAPIonly, DAPIonly, SAPIandDAPI" + $ref: "#/definitions/tapi.odu.TimDetMo" + ex-dapi: + type: "string" + description: "The Expected Destination Access Point Identifier (ExDAPI), provisioned\ + \ by the managing system, to be compared with the TTI accepted at the overhead\ + \ position of the sink for the purpose of checking the integrity of connectivity." + deg-m: + type: "integer" + format: "int32" + description: "This attribute indicates the threshold level for declaring a\ + \ Degraded Signal defect (dDEG). A dDEG shall be declared if DegM consecutive\ + \ bad PM Seconds are detected." + acti: + type: "string" + description: "The Trail Trace Identifier (TTI) information recovered (Accepted)\ + \ from the TTI overhead position at the sink of a trail." + ex-sapi: + type: "string" + description: "The Expected Source Access Point Identifier (ExSAPI), provisioned\ + \ by the managing system, to be compared with the TTI accepted at the overhead\ + \ position of the sink for the purpose of checking the integrity of connectivity.\r\ + \n " + deg-thr: + description: "This attribute indicates the threshold level for declaring a\ + \ performance monitoring (PM) Second to be bad. The value of the threshold\ + \ can be provisioned in terms of number of errored blocks or in terms of\ + \ percentage of errored blocks. For percentage-based specification, in order\ + \ to support provision of less than 1%, the specification consists of two\ + \ fields. The first field indicates the granularity of percentage. For examples,\ + \ in 1%, in 0.1%, or in 0.01%, etc. The second field indicates the multiple\ + \ of the granularity. For number of errored block based, the value is a\ + \ positive integer." + $ref: "#/definitions/tapi.odu.DegThr" + tim-act-disabled: + type: "boolean" + description: "This attribute provides the control capability for the managing\ + \ system to enable or disable the Consequent Action function when detecting\ + \ Trace Identifier Mismatch (TIM) at the trail termination sink." + default: true + tapi.odu.OduMipSpec: + type: "object" + properties: + odu-mip: + description: "none" + $ref: "#/definitions/tapi.odu.OduMipPac" + odu-pm: + description: "none" + $ref: "#/definitions/tapi.odu.OduPmPac" + odu-ncm: + description: "none" + $ref: "#/definitions/tapi.odu.OduNcmPac" + odu-tcm: + description: "none" + $ref: "#/definitions/tapi.odu.OduTcmMipPac" + odu-defect: + description: "none" + $ref: "#/definitions/tapi.odu.OduDefectPac" + tapi.odu.OduNamedPayloadType: + type: "string" + enum: + - "UNKNOWN" + - "UNINTERPRETABLE" + tapi.odu.OduNcmPac: + type: "object" + properties: + tcm-fields-in-use: + type: "array" + description: "This attribute indicates the used TCM fields of the ODU OH." + items: + type: "integer" + format: "int32" + tapi.odu.OduNodeEdgePointSpec: + type: "object" + properties: + odu-pool: + description: "none" + $ref: "#/definitions/tapi.odu.OduPoolPac" + tapi.odu.OduPayloadType: + type: "object" + properties: + hex-payload-type: + type: "integer" + format: "int32" + description: "none" + named-payload-type: + description: "none" + $ref: "#/definitions/tapi.odu.OduNamedPayloadType" + tapi.odu.OduPmPac: + type: "object" + properties: + f-ses: + type: "integer" + format: "int32" + description: "Far-end Severely Errored Second" + n-bbe: + type: "integer" + format: "int32" + description: "Near-end Background Block Error" + f-bbe: + type: "integer" + format: "int32" + description: "Far-end Background Block Error" + uas: + description: "UnAvailable Second" + $ref: "#/definitions/tapi.odu.UasChoice" + n-ses: + type: "integer" + format: "int32" + description: "Near-end Severely Errored Second" + tapi.odu.OduPoolPac: + type: "object" + properties: + client-capacity: + type: "integer" + format: "int32" + description: "none" + max-client-size: + type: "integer" + format: "int32" + description: "none" + max-client-instances: + type: "integer" + format: "int32" + description: "none" + tapi.odu.OduProtectionPac: + type: "object" + properties: + aps-enable: + type: "boolean" + description: "This attribute is for enabling/disabling the automatic protection\ + \ switching (APS) capability at the transport adaptation function that is\ + \ represented by the ODU_ConnectionTerminationPoint object class. It triggers\ + \ the MI_APS_EN signal to the transport adaptation function." + default: true + aps-level: + type: "integer" + format: "int32" + description: "This attribute is for configuring the automatic protection switching\ + \ (APS) level that should operate at the transport adaptation function that\ + \ is represented by the ODU_ConnectionTerminationPoint object class. It\ + \ triggers the MI_APS_LVL signal to the transport adaptation function. The\ + \ value 0 means path and the values 1 through 6 mean TCM level 1 through\ + \ 6 respectively." + tapi.odu.OduSlotSize: + type: "string" + enum: + - "1G25" + - "2G5" + tapi.odu.OduTcmMepPac: + type: "object" + properties: + admin-state-sink: + description: "This attribute provides the capability to provision the LOCK\ + \ signal at the sink, which is one of the ODU maintenance signals. When\ + \ a Tandem Connection endpoint is set to admin state locked, it will insert\ + \ the ODU-LCK signal in the downstream direction." + $ref: "#/definitions/tapi.common.AdministrativeState" + codirectional: + type: "boolean" + description: "This attribute specifies the directionality of the ODUT MEP\ + \ with respect to the associated ODU CEP. The value of TRUE means that the\ + \ sink part of the ODUT MEP terminates the same signal direction as the\ + \ sink part of the ODU CEP. The Source part behaves similarly. This attribute\ + \ is meaningful only on objects instantiated under ODU CEP, and at least\ + \ one among ODU CEP and the subordinate object is bidirectional." + default: false + admin-state-source: + description: "This attribute provides the capability to provision the LOCK\ + \ signal at the source, which is one of the ODU maintenance signals. When\ + \ a Tandem Connection endpoint is set to admin state locked, it will insert\ + \ the ODU-LCK signal in the source direction." + $ref: "#/definitions/tapi.common.AdministrativeState" + ac-status-source: + description: "This attribute indicates the status of the accepted TCM. " + $ref: "#/definitions/tapi.odu.TcmStatus" + tcm-extension: + description: "none" + $ref: "#/definitions/tapi.odu.TcmExtension" + ac-status-sink: + description: "This attribute indicates the status of the accepted TCM. " + $ref: "#/definitions/tapi.odu.TcmStatus" + tcm-mode: + description: "This attribute specifies the TCM mode at the entity. Valid values\ + \ are: Operational, Monitor, and Transparent." + $ref: "#/definitions/tapi.odu.TcmMode" + tcm-field: + type: "integer" + format: "int32" + description: "This attribute indicates the tandem connection monitoring field\ + \ of the ODU OH." + tapi.odu.OduTcmMipPac: + type: "object" + properties: + codirectional: + type: "boolean" + description: "This attribute specifies the directionality of the ODU MIP with\ + \ respect to the associated ODU CEP. The value of TRUE means that the (half\ + \ MIP/sink part of the) ODU MIP receives the same signal direction as the\ + \ sink part of the ODU CEP. The Source part behaves similarly. This attribute\ + \ is meaningful only on objects instantiated under ODU CEP, and at least\ + \ one among ODU CEP and the subordinate object is bidirectional." + default: false + tcm-field: + type: "integer" + format: "int32" + description: "This attribute indicates the tandem connection monitoring field\ + \ of the ODU OH." + tapi.odu.OduTerminationAndClientAdaptationPac: + type: "object" + properties: + configured-mapping-type: + description: "This attributes indicates the configured mapping type." + $ref: "#/definitions/tapi.odu.MappingType" + auto-payload-type: + type: "boolean" + description: "This attribute is applicable when the ODU CTP object instance\ + \ represents a lower order ODU CTP Source at the client layer of the ODUP/ODUj-21\ + \ adaptation function. The value of true of this attribute configures that\ + \ the adaptation source function shall fall back to the payload type PT=20\ + \ if the conditions specified in 14.3.10.1/G.798 are satisfied. " + default: false + accepted-payload-type: + description: "This attribute is applicable when the ODU CTP object instance\ + \ represents a lower order ODU CTP Sink at the client layer of the ODUP/ODU[i]j\ + \ or ODUP/ODUj-21 adaptation function. \r\n This attribute\ + \ is a 2-digit Hex code that indicates the new accepted payload type.\r\n\ + \ Valid values are defined in Table 15-8 of ITU-T Recommendation\ + \ G.709 with one additional value UN_INTERPRETABLE." + $ref: "#/definitions/tapi.odu.OduPayloadType" + opu-tributary-slot-size: + description: "This attribute is applicable for ODU2 and ODU3 CTP only. It\ + \ indicates the slot size of the ODU CTP." + $ref: "#/definitions/tapi.odu.OduSlotSize" + configured-client-type: + type: "string" + description: "This attribute configures the type of the client CTP of the\ + \ server ODU TTP." + tapi.odu.PercentageGranularity: + type: "string" + enum: + - "ONES" + - "ONE_TENTHS" + - "ONE_HUNDREDTHS" + - "ONE_THOUSANDTHS" + tapi.odu.TcmExtension: + type: "string" + enum: + - "NORMAL" + - "PASS-THROUGH" + - "ERASE" + tapi.odu.TcmMode: + type: "string" + enum: + - "OPERATIONAL" + - "TRANSPARENT" + - "MONITOR" + tapi.odu.TcmStatus: + type: "string" + enum: + - "NO_SOURCE_TC" + - "IN_USE_WITHOUT_IAE" + - "IN_USE_WITH_IAE" + - "RESERVED_1" + - "RESERVED_2" + - "LCK" + - "OCI" + - "AIS" + tapi.odu.TimDetMo: + type: "string" + enum: + - "DAPI" + - "SAPI" + - "BOTH" + - "OFF" + tapi.odu.UasChoice: + type: "object" + properties: + fuas: + type: "integer" + format: "int32" + description: "none" + bidirectional: + type: "boolean" + description: "none" + default: true + nuas: + type: "integer" + format: "int32" + description: "none" + uas: + type: "integer" + format: "int32" + description: "none" + 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.PathComputationService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $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" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + optimization-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "none" + tapi.path.computation.PathObjectiveFunction: + allOf: + - $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.PathOptimizationConstraint: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + traffic-interruption: + description: "none" + $ref: "#/definitions/tapi.common.DirectiveValue" + description: "none" + 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.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.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 + tolerable-impact: + type: "string" + description: "Grades of maximum tolerable disruption to traffic." + 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" + 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" + tapi.path.computation.TopologyConstraint: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + include-node: + type: "string" + description: "This is a loose constraint - that is it is unordered and could\ + \ be a partial list" + exclude-link: + type: "string" + description: "none" + avoid-topology: + type: "string" + description: "none" + exclude-path: + type: "string" + description: "none" + include-topology: + type: "string" + description: "none" + include-path: + type: "string" + description: "none" + exclude-node-edge-point: + type: "string" + description: "none" + include-node-edge-point: + type: "string" + description: "none" + include-link: + type: "string" + description: "This is a loose constraint - that is it is unordered and could\ + \ be a partial list " + preferred-transport-layer: + description: "soft constraint requested by client to indicate the layer(s)\ + \ of transport connection that it prefers to carry the service. This could\ + \ be same as the service layer or one of the supported server layers" + $ref: "#/definitions/tapi.common.LayerProtocolName" + exclude-node: + type: "string" + description: "none" + constraint-weight: + type: "integer" + format: "int32" + description: "Zero and positive values: zero means 'strongly required to\ + \ be included', +1 means 'less strongly required to be included', etc.\r\ + \n For example the work/intended route will be calculated\ + \ considering the topologies which weights are lowest (but not negative).\r\ + \n Negative values: -1 means 'strongly required to be excluded',\ + \ -2 means 'less strongly required to be excluded', etc." + description: "The TopologyConstraint allows to specify topology entities in\ + \ order to impose specific constraints (as denoted by the attribute name)\ + \ on Connectivity/Path.\r\n The topology entities are specified\ + \ by their instance uuid rather than using references/path (to allow for mapping\ + \ to Yang 1.0).\r\n This loose typing and reference necessitates\ + \ that implementations validate not only the presence of the instance, but\ + \ also that it is of the correct type as implied by the attribute name.\r\n\ + \ If this validation fails, then the implementation is expceted\ + \ to return an error.\r\n " + tapi.path.computation.computep2ppath.Input: + type: "object" + properties: + topology-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + objective-function: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.path.computation.computep2ppath.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathComputationService" + tapi.path.computation.deletep2ppath.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.path.computation.deletep2ppath.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathComputationService" + tapi.path.computation.optimizep2ppath.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + optimization-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + objective-function: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + tapi.path.computation.optimizep2ppath.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathComputationService" + tapi.topology.ContextAugmentation5: + type: "object" + properties: + topology-context: + description: "Augments the base TAPI Context with TopologyService information" + $ref: "#/definitions/tapi.topology.TopologyContext" + x-augmentation: + prefix: "tapi-topology" + namespace: "urn:onf:otcc:yang:tapi-topology" + tapi.topology.CostCharacteristic: + type: "object" + properties: + cost-value: + type: "string" + description: "The specific cost." + cost-algorithm: + type: "string" + description: "The cost may vary based upon some properties of the TopologicalEntity.\ + \ The rules for the variation are conveyed by the costAlgorithm." + cost-name: + type: "string" + description: "The cost characteristic will related to some aspect of the TopologicalEntity\ + \ (e.g. $ cost, routing weight). This aspect will be conveyed by the costName." + tapi.topology.ForwardingRule: + type: "string" + enum: + - "MAY_FORWARD_ACROSS_GROUP" + - "MUST_FORWARD_ACROSS_GROUP" + - "CANNOT_FORWARD_ACROSS_GROUP" + - "NO_STATEMENT_ON_FORWARDING" + tapi.topology.GetLinkDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getlinkdetails.Output" + tapi.topology.GetNodeDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getnodedetails.Output" + tapi.topology.GetNodeEdgePointDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Output" + tapi.topology.GetTopologyDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.gettopologydetails.Output" + tapi.topology.GetTopologyList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.gettopologylist.Output" + tapi.topology.InterRuleGroup: + allOf: + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + associated-node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + rule: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Rule" + description: "none" + tapi.topology.LatencyCharacteristic: + type: "object" + properties: + traffic-property-name: + type: "string" + description: "The identifier of the specific traffic property to which the\ + \ queuing latency applies." + jitter-characteristic: + type: "string" + description: "High frequency deviation from true periodicity of a signal and\ + \ therefore a small high rate of change of transfer latency.\r\n \ + \ Applies to TDM systems (and not packet)." + fixed-latency-characteristic: + type: "string" + description: "A TopologicalEntity suffers delay caused by the realization\ + \ of the servers (e.g. distance related; FEC encoding etc.) along with some\ + \ client specific processing. This is the total average latency effect of\ + \ the TopologicalEntity" + wander-characteristic: + type: "string" + description: "Low frequency deviation from true periodicity of a signal and\ + \ therefore a small low rate of change of transfer latency.\r\n \ + \ Applies to TDM systems (and not packet)." + queing-latency-characteristic: + type: "string" + description: "The specific queuing latency for the traffic property." + tapi.topology.LayerProtocolTransitionPac: + type: "object" + properties: + transitioned-layer-protocol-name: + type: "array" + description: "Provides the ordered structure of layer protocol transitions\ + \ encapsulated in the TopologicalEntity. The ordering relates to the LinkPort\ + \ role." + items: + type: "string" + tapi.topology.Link: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.LayerProtocolTransitionPac" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - $ref: "#/definitions/tapi.topology.ValidationPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + restoration-policy: + description: "none" + $ref: "#/definitions/tapi.topology.RestorationPolicy" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" + direction: + description: "The directionality of the Link. \r\n Is applicable\ + \ to simple Links where all LinkEnds are BIDIRECTIONAL (the Link will\ + \ be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ + \ \r\n Is not present in more complex cases." + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "The Link object class models effective adjacency between two or\ + \ more ForwardingDomains (FD). " + tapi.topology.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.NepLayerProtocolCapability: + type: "object" + properties: + layer-protocol-qualifier: + type: "string" + description: "none" + number-of-cep-instances: + type: "integer" + format: "int32" + description: "none" + tapi.topology.NetworkTopologyService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.TopologyRef" + description: "none" + tapi.topology.Node: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + encap-topology: + description: "none" + $ref: "#/definitions/tapi.topology.TopologyRef" + node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePoint" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ + \ topological component which is used to effect forwarding of transport characteristic\ + \ information and offers the potential to enable forwarding. \r\n \ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ multiple switch matrices (FDs). " + tapi.topology.NodeEdgePoint: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.common.TerminationPac" + - type: "object" + properties: + link-port-role: + description: "Each LinkEnd of the Link has a role (e.g., symmetric, hub,\ + \ spoke, leaf, root) in the context of the Link with respect to the Link\ + \ function. " + $ref: "#/definitions/tapi.common.PortRole" + mapped-service-interface-point: + type: "array" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load\ + \ balancing/Resilience) should be considered experimental" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + available-cep-layer-protocol: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + link-port-direction: + description: "The orientation of defined flow at the LinkEnd." + $ref: "#/definitions/tapi.common.PortDirection" + description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ + \ termination and adaptation functions of one or more transport layers. \r\ + \n The structure of LTP supports all transport protocols including\ + \ circuit and packet forms." + tapi.topology.NodeEdgePointRef: + allOf: + - $ref: "#/definitions/tapi.topology.NodeRef" + - type: "object" + properties: + node-edge-point-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-edge-point/tapi-topology:uuid" + description: "none" + tapi.topology.NodeRef: + allOf: + - $ref: "#/definitions/tapi.topology.TopologyRef" + - type: "object" + properties: + node-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:uuid" + description: "none" + tapi.topology.NodeRuleGroup: + allOf: + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + inter-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.InterRuleGroup" + rule: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Rule" + composed-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "none" + tapi.topology.NodeRuleGroupRef: + allOf: + - $ref: "#/definitions/tapi.topology.NodeRef" + - type: "object" + properties: + node-rule-group-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-rule-group/tapi-topology:uuid" + description: "none" + tapi.topology.ProtectionType: + type: "string" + enum: + - "NO_PROTECTION" + - "ONE_PLUS_ONE_PROTECTION" + - "ONE_FOR_ONE_PROTECTION" + - "ONE_FOR_N_PROTECTION" + - "M_FOR_N_PROTECTION" + - "ONE_FOR_ONE_BY_N" + tapi.topology.RestorationPolicy: + type: "string" + enum: + - "PER_DOMAIN_RESTORATION" + - "END_TO_END_RESTORATION" + - "NA" + - "DYNAMIC_RESTORATION" + - "PRE_COMPUTED_RESTORATION" + tapi.topology.RiskCharacteristic: + type: "object" + properties: + risk-characteristic-name: + type: "string" + description: "The name of the risk characteristic. The characteristic may\ + \ be related to a specific degree of closeness. \r\n For\ + \ example a particular characteristic may apply to failures that are localized\ + \ (e.g. to one side of a road) where as another characteristic may relate\ + \ to failures that have a broader impact (e.g. both sides of a road that\ + \ crosses a bridge).\r\n Depending upon the importance of\ + \ the traffic being routed different risk characteristics will be evaluated." + risk-identifier-list: + type: "array" + description: "A list of the identifiers of each physical/geographic unit (with\ + \ the specific risk characteristic) that is related to a segment of the\ + \ TopologicalEntity." + items: + type: "string" + tapi.topology.RiskParameterPac: + type: "object" + properties: + risk-characteristic: + type: "array" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + items: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + tapi.topology.Rule: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + override-priority: + type: "integer" + format: "int32" + description: "none" + forwarding-rule: + description: "none" + $ref: "#/definitions/tapi.topology.ForwardingRule" + rule-type: + description: "none" + $ref: "#/definitions/tapi.topology.RuleType" + description: "none" + tapi.topology.RuleType: + type: "string" + enum: + - "FORWARDING" + - "CAPACITY" + - "COST" + - "TIMING" + - "RISK" + - "GROUPING" + tapi.topology.Topology: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + link: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Link" + node: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Node" + boundary-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ + \ topological component which is used to effect forwarding of transport characteristic\ + \ information and offers the potential to enable forwarding. \r\n \ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ multiple switch matrices (FDs). " + tapi.topology.TopologyContext: + type: "object" + properties: + nw-topology-service: + description: "none" + $ref: "#/definitions/tapi.topology.NetworkTopologyService" + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.TopologyRef: + type: "object" + properties: + topology-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:uuid" + tapi.topology.TransferCostPac: + type: "object" + properties: + cost-characteristic: + type: "array" + description: "The list of costs where each cost relates to some aspect of\ + \ the TopologicalEntity." + items: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + tapi.topology.TransferIntegrityPac: + type: "object" + properties: + error-characteristic: + type: "string" + description: "Describes the degree to which the signal propagated can be errored.\ + \ \r\n Applies to TDM systems as the errored signal will\ + \ be propagated and not packet as errored packets will be discarded." + unavailable-time-characteristic: + type: "string" + description: "Describes the duration for which there may be no valid signal\ + \ propagated." + server-integrity-process-characteristic: + type: "string" + description: "Describes the effect of any server integrity enhancement process\ + \ on the characteristics of the TopologicalEntity." + delivery-order-characteristic: + type: "string" + description: "Describes the degree to which packets will be delivered out\ + \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ + \ maintain strict order." + repeat-delivery-characteristic: + type: "string" + description: "Primarily applies to packet systems where a packet may be delivered\ + \ more than once (in fault recovery for example). \r\n It\ + \ can also apply to TDM where several frames may be received twice due to\ + \ switching in a system with a large differential propagation delay." + loss-characteristic: + type: "string" + description: "Describes the acceptable characteristic of lost packets where\ + \ loss may result from discard due to errors or overflow.\r\n \ + \ Applies to packet systems and not TDM (as for TDM errored signals\ + \ are propagated unless grossly errored and overflow/underflow turns into\ + \ timing slips)." + tapi.topology.TransferTimingPac: + type: "object" + properties: + latency-characteristic: + type: "array" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + items: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + tapi.topology.ValidationMechanism: + type: "object" + properties: + layer-protocol-adjacency-validated: + type: "string" + description: "State of validatiion" + validation-mechanism: + type: "string" + description: "Name of mechanism used to validate adjacency" + validation-robustness: + type: "string" + description: "Quality of validation (i.e. how likely is the stated validation\ + \ to be invalid)" + tapi.topology.ValidationPac: + type: "object" + properties: + validation-mechanism: + type: "array" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." + items: + $ref: "#/definitions/tapi.topology.ValidationMechanism" + tapi.topology.getlinkdetails.Input: + type: "object" + properties: + link-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getlinkdetails.Output: + type: "object" + properties: + link: + description: "none" + $ref: "#/definitions/tapi.topology.Link" + tapi.topology.getnodedetails.Input: + type: "object" + properties: + node-id: + type: "string" + description: "UUID of the Node: An identifier that is universally unique within\ + \ an identifier space, where the identifier space is itself globally unique,\ + \ and immutable.\r\n An UUID carries no semantics with\ + \ respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The canonical\ + \ representation uses lowercase characters.\r\n Pattern:\ + \ [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getnodedetails.Output: + type: "object" + properties: + node: + description: "none" + $ref: "#/definitions/tapi.topology.Node" + tapi.topology.getnodeedgepointdetails.Input: + type: "object" + properties: + node-id: + type: "string" + description: "UUID of the parent Node: An identifier that is universally unique\ + \ within an identifier space, where the identifier space is itself globally\ + \ unique, and immutable.\r\n An UUID carries no semantics\ + \ with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The\ + \ canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Node's Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + node-edge-point-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getnodeedgepointdetails.Output: + type: "object" + properties: + node-edge-point: + description: "none" + $ref: "#/definitions/tapi.topology.NodeEdgePoint" + tapi.topology.gettopologydetails.Input: + type: "object" + properties: + topology-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.gettopologydetails.Output: + type: "object" + properties: + topology: + description: "none" + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.gettopologylist.Output: + type: "object" + properties: + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.node.NodeEdgePoint: + allOf: + - $ref: "#/definitions/tapi.connectivity.NodeEdgePointAugmentation2" + - $ref: "#/definitions/tapi.odu.NodeEdgePointAugmentation1" + - $ref: "#/definitions/tapi.topology.NodeEdgePoint" + tapi.topology.topology.Node: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + encap-topology: + description: "none" + $ref: "#/definitions/tapi.topology.TopologyRef" + node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.node.NodeEdgePoint" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "none" diff --git a/OAS/tapi-path-computation@2019-03-31.yaml b/OAS/tapi-path-computation@2019-03-31.yaml new file mode 100644 index 00000000..cd1e4758 --- /dev/null +++ b/OAS/tapi-path-computation@2019-03-31.yaml @@ -0,0 +1,7237 @@ +--- +swagger: "2.0" +info: + description: "\r\n This module contains TAPI Notification Model definitions.\r\ + \n Source: TapiNotification.uml\r\n Copyright (c) 2018 Open Networking\ + \ Foundation (ONF). All rights reserved.\r\n License: This module is distributed\ + \ under the Apache License 2.0\r\n - The TAPI YANG models included in this\ + \ TAPI release are a *normative* part of the TAPI SDK.\r\n - The YANG specifications\ + \ have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG\ + \ mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Topology\ + \ Model definitions.\r\n Source: TapiTopology.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Common Model\ + \ definitions.\r\n Source: TapiCommon.uml\r\n Copyright (c) 2018\ + \ Open Networking Foundation (ONF). All rights reserved.\r\n License: This\ + \ module is distributed under the Apache License 2.0\r\n - The TAPI YANG\ + \ models included in this TAPI release are a *normative* part of the TAPI SDK.\r\ + \n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Path Computation\ + \ Model definitions.\r\n Source: TapiPathComputation.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases." + version: "2.2.0" + title: "tapi-notification,tapi-topology,tapi-common,tapi-path-computation API" +host: "localhost:1234" +consumes: +- "application/yang-data+json" +produces: +- "application/yang-data+json" +paths: + /data/context/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Context" + description: "none" + parameters: [] + responses: + 200: + description: "tapi.common.Context" + schema: + $ref: "#/definitions/tapi.common.Context" + 400: + description: "Internal error" + post: + tags: + - "tapi-common" + summary: "creates tapi.common.Context" + description: "none" + parameters: + - in: "body" + name: "tapi.common.Context.body-param" + description: "tapi.common.Context to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.Context" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.Context" + description: "none" + parameters: + - in: "body" + name: "tapi.common.Context.body-param" + description: "tapi.common.Context to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.Context" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.Context" + description: "none" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/name/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] + responses: + 200: + description: "tapi.notification.NotificationContext" + schema: + $ref: "#/definitions/tapi.notification.NotificationContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: + - in: "body" + name: "tapi.notification.NotificationContext.body-param" + description: "tapi.notification.NotificationContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: + - in: "body" + name: "tapi.notification.NotificationContext.body-param" + description: "tapi.notification.NotificationContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - in: "body" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NotificationSubscriptionService" + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/name/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/notification-channel/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationChannel" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NotificationChannel" + schema: + $ref: "#/definitions/tapi.notification.NotificationChannel" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.Notification" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.Notification" + schema: + $ref: "#/definitions/tapi.notification.Notification" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.SubscriptionFilter" + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + 400: + description: "Internal error" + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notification={uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.Notification" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.Notification" + schema: + $ref: "#/definitions/tapi.notification.Notification" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/additional-info={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/path-computation-context/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: [] + responses: + 200: + description: "tapi.path.computation.PathComputationContext" + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: + - in: "body" + name: "tapi.path.computation.PathComputationContext.body-param" + description: "tapi.path.computation.PathComputationContext to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: + - in: "body" + name: "tapi.path.computation.PathComputationContext.body-param" + description: "tapi.path.computation.PathComputationContext to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathComputationService" + description: "none" + parameters: + - in: "body" + name: "tapi.path.computation.PathComputationService.body-param" + description: "tapi.path.computation.PathComputationService to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathComputationService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.PathComputationService" + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationService" + 400: + description: "Internal error" + 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.PathComputationService" + 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/context/path-computation-context/path-comp-service={uuid}/end-point/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathServiceEndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.PathServiceEndPoint.body-param" + description: "tapi.path.computation.PathServiceEndPoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathServiceEndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.PathServiceEndPoint" + schema: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-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.PathServiceEndPoint" + 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/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of 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.Capacity" + 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.Capacity" + 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.Capacity" + 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/context/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.CapacityValue" + 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.CapacityValue" + 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.CapacityValue" + 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/context/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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/service-interface-point/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePointRef" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 400: + description: "Internal error" + post: + tags: + - "tapi-path-computation" + 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.ServiceInterfacePointRef" + 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.ServiceInterfacePointRef" + 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/context/path-computation-context/path-comp-service={uuid}/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/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.PathObjectiveFunction" + 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.PathObjectiveFunction" + 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.PathObjectiveFunction" + 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/context/path-computation-context/path-comp-service={uuid}/objective-function/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/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.PathOptimizationConstraint" + 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.PathOptimizationConstraint" + 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.PathOptimizationConstraint" + 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/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/path={path-uuid}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "path-uuid" + in: "path" + description: "Id of path" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.PathRef" + schema: + $ref: "#/definitions/tapi.path.computation.PathRef" + 400: + description: "Internal error" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.RoutingConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + 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.CostCharacteristic" + 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/context/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.LatencyCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-path-computation" + 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.LatencyCharacteristic" + 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.LatencyCharacteristic" + 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/context/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.RiskCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-path-computation" + 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.RiskCharacteristic" + 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.RiskCharacteristic" + 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/context/path-computation-context/path-comp-service={uuid}/topology-constraint/: + 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.TopologyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/: + 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" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.TopologyConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + 400: + description: "Internal error" + put: + tags: + - "tapi-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" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object 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" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/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.Path" + 400: + description: "Internal error" + /data/context/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.LinkRef" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/: + get: + tags: + - "tapi-path-computation" + 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.RoutingConstraint" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-path-computation" + 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.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/: + get: + tags: + - "tapi-path-computation" + 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.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/service-interface-point/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - in: "body" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/service-interface-point={uuid}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePoint" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/available-capacity/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/name/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/service-interface-point={uuid}/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/total-potential-capacity/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] + responses: + 200: + description: "tapi.topology.TopologyContext" + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-topology" + summary: "creates tapi.topology.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: + - in: "body" + name: "tapi.topology.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-topology" + summary: "creates or updates tapi.topology.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: + - in: "body" + name: "tapi.topology.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-topology" + summary: "removes tapi.topology.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/topology-context/nw-topology-service/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NetworkTopologyService" + description: "none" + parameters: [] + responses: + 200: + description: "tapi.topology.NetworkTopologyService" + schema: + $ref: "#/definitions/tapi.topology.NetworkTopologyService" + 400: + description: "Internal error" + /data/context/topology-context/nw-topology-service/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.TopologyRef" + description: "none" + parameters: + - name: "topology-uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.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.Topology" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/boundary-node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Link" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Link" + schema: + $ref: "#/definitions/tapi.topology.Link" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.ValidationMechanism" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "validation-mechanism" + in: "path" + description: "Id of validation-mechanism" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.ValidationMechanism" + schema: + $ref: "#/definitions/tapi.topology.ValidationMechanism" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.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.Node" + schema: + $ref: "#/definitions/tapi.topology.Node" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.TopologyRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePoint" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePoint" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{aggregated-node-edge-point-node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-cep-layer-protocol={layer-protocol-qualifier}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NepLayerProtocolCapability" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "layer-protocol-qualifier" + in: "path" + description: "Id of available-cep-layer-protocol" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NepLayerProtocolCapability" + schema: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load balancing/Resilience)\ + \ should be considered experimental" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "service-interface-point-uuid" + in: "path" + description: "Id of mapped-service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePointRef" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroup" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroup" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-rule-group-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroupRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.InterRuleGroup" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.InterRuleGroup" + schema: + $ref: "#/definitions/tapi.topology.InterRuleGroup" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + - name: "associated-node-rule-group-node-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + - name: "associated-node-rule-group-node-rule-group-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroupRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Rule" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Rule" + schema: + $ref: "#/definitions/tapi.topology.Rule" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-node-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Rule" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Rule" + schema: + $ref: "#/definitions/tapi.topology.Rule" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /operations/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/create-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.CreateNotificationSubscriptionService" + description: "operates on tapi.notification.CreateNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.CreateNotificationSubscriptionService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.DeleteNotificationSubscriptionService" + description: "operates on tapi.notification.DeleteNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.deletenotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/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/get-link-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetLinkDetails" + description: "operates on tapi.topology.GetLinkDetails" + parameters: + - in: "body" + name: "tapi.topology.getlinkdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getlinkdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetLinkDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-node-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetNodeDetails" + description: "operates on tapi.topology.GetNodeDetails" + parameters: + - in: "body" + name: "tapi.topology.getnodedetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getnodedetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetNodeDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-node-edge-point-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetNodeEdgePointDetails" + description: "operates on tapi.topology.GetNodeEdgePointDetails" + parameters: + - in: "body" + name: "tapi.topology.getnodeedgepointdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetNodeEdgePointDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-list/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationList" + description: "operates on tapi.notification.GetNotificationList" + parameters: + - in: "body" + name: "tapi.notification.getnotificationlist.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.getnotificationlist.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-subscription-service-details/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + description: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + parameters: + - in: "body" + name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-subscription-service-list/: + post: + tags: + - "tapi-notification" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-service-interface-point-details/: + post: + tags: + - "tapi-common" + summary: "operates on tapi.common.GetServiceInterfacePointDetails" + description: "operates on tapi.common.GetServiceInterfacePointDetails" + parameters: + - in: "body" + name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.common.GetServiceInterfacePointDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-service-interface-point-list/: + post: + tags: + - "tapi-common" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.common.GetServiceInterfacePointList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-supported-notification-types/: + post: + tags: + - "tapi-notification" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetSupportedNotificationTypes" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-topology-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetTopologyDetails" + description: "operates on tapi.topology.GetTopologyDetails" + parameters: + - in: "body" + name: "tapi.topology.gettopologydetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.gettopologydetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetTopologyDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-topology-list/: + post: + tags: + - "tapi-topology" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetTopologyList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/optimize-p-2-p-path/: + 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/update-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.UpdateNotificationSubscriptionService" + description: "operates on tapi.notification.UpdateNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.UpdateNotificationSubscriptionService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-service-interface-point/: + post: + tags: + - "tapi-common" + summary: "operates on tapi.common.UpdateServiceInterfacePoint" + description: "operates on tapi.common.UpdateServiceInterfacePoint" + parameters: + - in: "body" + name: "tapi.common.updateserviceinterfacepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.common.updateserviceinterfacepoint.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" +definitions: + tapi.common.AdminStatePac: + type: "object" + properties: + operational-state: + description: "none" + $ref: "#/definitions/tapi.common.OperationalState" + lifecycle-state: + description: "none" + $ref: "#/definitions/tapi.common.LifecycleState" + administrative-state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + tapi.common.AdministrativeState: + type: "string" + enum: + - "LOCKED" + - "UNLOCKED" + tapi.common.Capacity: + type: "object" + properties: + total-size: + description: "Total capacity of the TopologicalEntity in MB/s. In case of\ + \ bandwidthProfile, this is expected to same as the committedInformationRate." + $ref: "#/definitions/tapi.common.CapacityValue" + tapi.common.CapacityPac: + type: "object" + properties: + available-capacity: + description: "Capacity available to be assigned." + $ref: "#/definitions/tapi.common.Capacity" + total-potential-capacity: + description: "An optimistic view of the capacity of the TopologicalEntity\ + \ assuming that any shared capacity is available to be taken." + $ref: "#/definitions/tapi.common.Capacity" + tapi.common.CapacityUnit: + type: "string" + enum: + - "TB" + - "TBPS" + - "GB" + - "GBPS" + - "MB" + - "MBPS" + - "KB" + - "KBPS" + - "GHz" + - "MHz" + tapi.common.CapacityValue: + type: "object" + properties: + value: + type: "integer" + format: "int32" + description: "none" + unit: + description: "none" + $ref: "#/definitions/tapi.common.CapacityUnit" + tapi.common.Context: + allOf: + - $ref: "#/definitions/tapi.common.TapiContext" + - $ref: "#/definitions/tapi.notification.ContextAugmentation2" + - $ref: "#/definitions/tapi.path.computation.ContextAugmentation1" + - $ref: "#/definitions/tapi.topology.ContextAugmentation3" + 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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a UUID\ + \ in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.common.LayerProtocolName: + type: "string" + enum: + - "ODU" + - "ETH" + - "DSR" + - "PHOTONIC_MEDIA" + tapi.common.LifecycleState: + type: "string" + enum: + - "PLANNED" + - "POTENTIAL_AVAILABLE" + - "POTENTIAL_BUSY" + - "INSTALLED" + - "PENDING_REMOVAL" + tapi.common.LocalClass: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + local-id: + type: "string" + description: "none" + tapi.common.NameAndValue: + type: "object" + properties: + value-name: + type: "string" + description: "The name of the value. The value need not have a name." + value: + type: "string" + description: "The value" + tapi.common.OperationalState: + type: "string" + enum: + - "DISABLED" + - "ENABLED" + tapi.common.PortDirection: + type: "string" + enum: + - "BIDIRECTIONAL" + - "INPUT" + - "OUTPUT" + - "UNIDENTIFIED_OR_UNKNOWN" + tapi.common.PortRole: + type: "string" + enum: + - "SYMMETRIC" + - "ROOT" + - "LEAF" + - "TRUNK" + - "UNKNOWN" + tapi.common.ServiceInterfacePoint: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + supported-layer-protocol-qualifier: + type: "array" + description: "none" + items: + type: "string" + layer-protocol-name: + description: "Usage of layerProtocolName [>1] in the ServiceInterfacePoint\ + \ should be considered experimental" + $ref: "#/definitions/tapi.common.LayerProtocolName" + description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ + \ termination and adaptation functions of one or more transport layers. \r\ + \n The structure of LTP supports all transport protocols including\ + \ circuit and packet forms." + tapi.common.ServiceInterfacePointRef: + type: "object" + properties: + service-interface-point-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-common:service-interface-point/tapi-common:uuid" + tapi.common.TapiContext: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + service-interface-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + description: "The Network Control Domain (NCD) object class represents the scope\ + \ of control that a particular SDN controller has with respect to a particular\ + \ network, (i.e., encompassing a designated set of interconnected (virtual)\ + \ network elements)." + tapi.common.TerminationDirection: + type: "string" + enum: + - "BIDIRECTIONAL" + - "SINK" + - "SOURCE" + - "UNDEFINED_OR_UNKNOWN" + tapi.common.TerminationPac: + type: "object" + properties: + termination-direction: + description: "The overall directionality of the LP. \r\n -\ + \ A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ + \ - A SINK LP can only contain elements with SINK flows or CONTRA_DIRECTION_SOURCE\ + \ flows\r\n - A SOURCE LP can only contain SOURCE flows or\ + \ CONTRA_DIRECTION_SINK flows" + $ref: "#/definitions/tapi.common.TerminationDirection" + termination-state: + description: "Indicates whether the layer is terminated and if so how." + $ref: "#/definitions/tapi.common.TerminationState" + tapi.common.TerminationState: + type: "string" + enum: + - "LP_CAN_NEVER_TERMINATE" + - "LT_NOT_TERMINATED" + - "TERMINATED_SERVER_TO_CLIENT_FLOW" + - "TERMINATED_CLIENT_TO_SERVER_FLOW" + - "TERMINATED_BIDIRECTIONAL" + - "LT_PERMENANTLY_TERMINATED" + - "TERMINATION_STATE_UNKNOWN" + tapi.common.TimeRange: + type: "object" + properties: + end-time: + type: "string" + description: "none" + start-time: + type: "string" + description: "none" + tapi.common.getserviceinterfacepointdetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.common.getserviceinterfacepointdetails.Output: + type: "object" + properties: + sip: + description: "none" + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + tapi.common.getserviceinterfacepointlist.Output: + type: "object" + properties: + sip: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + tapi.common.updateserviceinterfacepoint.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + tapi.notification.ContextAugmentation2: + type: "object" + properties: + notification-context: + description: "Augments the base TAPI Context with NotificationService information" + $ref: "#/definitions/tapi.notification.NotificationContext" + x-augmentation: + prefix: "tapi-notification" + namespace: "urn:onf:otcc:yang:tapi-notification" + tapi.notification.CreateNotificationSubscriptionService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Output" + tapi.notification.GetNotificationList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationlist.Output" + tapi.notification.GetNotificationSubscriptionServiceDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Output" + tapi.notification.GetNotificationSubscriptionServiceList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicelist.Output" + tapi.notification.GetSupportedNotificationTypes: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getsupportednotificationtypes.Output" + tapi.notification.NameAndValueChange: + type: "object" + properties: + value-name: + type: "string" + description: "The name of the value. The value need not have a name." + old-value: + type: "string" + description: "The value" + new-value: + type: "string" + description: "The value" + tapi.notification.Notification: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + target-object-type: + type: "string" + description: "none" + additional-text: + type: "string" + description: "none" + event-time-stamp: + type: "string" + description: "none" + additional-info: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.NameAndValue" + sequence-number: + type: "integer" + format: "int32" + description: "A monotonous increasing sequence number associated with the\ + \ notification.\r\n The exact semantics of how this sequence\ + \ number is assigned (per channel or subscription or source or system)\ + \ is left undefined." + target-object-identifier: + type: "string" + description: "none" + notification-type: + type: "string" + description: "none" + target-object-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.NameAndValue" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + source-indicator: + description: "none" + $ref: "#/definitions/tapi.notification.SourceIndicator" + layer-protocol-qualifier: + type: "string" + description: "none" + changed-attributes: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + description: "none" + tapi.notification.NotificationChannel: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + next-sequence-no: + type: "integer" + format: "int32" + description: "The sequence number of the next notification that will be\ + \ published on the channel" + stream-address: + type: "string" + description: "The address/location/URI of the channel/stream to which the\ + \ subscribed notifications are published.\r\n This specifics\ + \ of this is typically dependent on the implementation protocol & mechanism\ + \ and hence is typed as a string." + description: "none" + tapi.notification.NotificationContext: + type: "object" + properties: + notif-subscription: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.Notification" + tapi.notification.NotificationSubscriptionService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.Notification" + notification-channel: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationChannel" + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + supported-object-types: + type: "array" + description: "none" + items: + type: "string" + supported-notification-types: + type: "array" + description: "none" + items: + type: "string" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + description: "none" + tapi.notification.SourceIndicator: + type: "string" + enum: + - "RESOURCE_OPERATION" + - "MANAGEMENT_OPERATION" + - "UNKNOWN" + tapi.notification.SubscriptionFilter: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + requested-notification-types: + type: "array" + description: "none" + items: + type: "string" + requested-object-identifier: + type: "array" + description: "none" + items: + type: "string" + requested-layer-protocols: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + include-content: + type: "boolean" + description: "Indicates whether the published Notification includes content\ + \ or just the Notification Id (which enables retrieval of the notification\ + \ at the later stage)" + default: false + requested-object-types: + type: "array" + description: "none" + items: + type: "string" + description: "none" + tapi.notification.SubscriptionState: + type: "string" + enum: + - "SUSPENDED" + - "ACTIVE" + tapi.notification.UpdateNotificationSubscriptionService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Output" + tapi.notification.createnotificationsubscriptionservice.Input: + type: "object" + properties: + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + tapi.notification.createnotificationsubscriptionservice.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.deletenotificationsubscriptionservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationlist.Input: + type: "object" + properties: + time-range: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + subscription-id: + type: "string" + description: "UUID of the associated Notification Subscription Service: An\ + \ identifier that is universally unique within an identifier space, where\ + \ the identifier space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationlist.Output: + type: "object" + properties: + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.Notification" + tapi.notification.getnotificationsubscriptionservicedetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationsubscriptionservicedetails.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.getnotificationsubscriptionservicelist.Output: + type: "object" + properties: + subscription-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.getsupportednotificationtypes.Output: + type: "object" + properties: + supported-object-types: + type: "array" + description: "none" + items: + type: "string" + supported-notification-types: + type: "array" + description: "none" + items: + type: "string" + tapi.notification.updatenotificationsubscriptionservice.Input: + type: "object" + properties: + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + tapi.notification.updatenotificationsubscriptionservice.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.path.computation.ComputeP2PPath: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.path.computation.computep2ppath.Output" + tapi.path.computation.ContextAugmentation1: + 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.PathComputationService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $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" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + optimization-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "none" + tapi.path.computation.PathObjectiveFunction: + allOf: + - $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.PathOptimizationConstraint: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + traffic-interruption: + description: "none" + $ref: "#/definitions/tapi.common.DirectiveValue" + description: "none" + 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.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.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 + tolerable-impact: + type: "string" + description: "Grades of maximum tolerable disruption to traffic." + 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" + 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" + tapi.path.computation.TopologyConstraint: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + include-node: + type: "string" + description: "This is a loose constraint - that is it is unordered and could\ + \ be a partial list" + exclude-link: + type: "string" + description: "none" + avoid-topology: + type: "string" + description: "none" + exclude-path: + type: "string" + description: "none" + include-topology: + type: "string" + description: "none" + include-path: + type: "string" + description: "none" + exclude-node-edge-point: + type: "string" + description: "none" + include-node-edge-point: + type: "string" + description: "none" + include-link: + type: "string" + description: "This is a loose constraint - that is it is unordered and could\ + \ be a partial list " + preferred-transport-layer: + description: "soft constraint requested by client to indicate the layer(s)\ + \ of transport connection that it prefers to carry the service. This could\ + \ be same as the service layer or one of the supported server layers" + $ref: "#/definitions/tapi.common.LayerProtocolName" + exclude-node: + type: "string" + description: "none" + constraint-weight: + type: "integer" + format: "int32" + description: "Zero and positive values: zero means 'strongly required to\ + \ be included', +1 means 'less strongly required to be included', etc.\r\ + \n For example the work/intended route will be calculated\ + \ considering the topologies which weights are lowest (but not negative).\r\ + \n Negative values: -1 means 'strongly required to be excluded',\ + \ -2 means 'less strongly required to be excluded', etc." + description: "The TopologyConstraint allows to specify topology entities in\ + \ order to impose specific constraints (as denoted by the attribute name)\ + \ on Connectivity/Path.\r\n The topology entities are specified\ + \ by their instance uuid rather than using references/path (to allow for mapping\ + \ to Yang 1.0).\r\n This loose typing and reference necessitates\ + \ that implementations validate not only the presence of the instance, but\ + \ also that it is of the correct type as implied by the attribute name.\r\n\ + \ If this validation fails, then the implementation is expceted\ + \ to return an error.\r\n " + tapi.path.computation.computep2ppath.Input: + type: "object" + properties: + topology-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + objective-function: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.path.computation.computep2ppath.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathComputationService" + tapi.path.computation.deletep2ppath.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.path.computation.deletep2ppath.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathComputationService" + tapi.path.computation.optimizep2ppath.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + optimization-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + objective-function: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + tapi.path.computation.optimizep2ppath.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathComputationService" + tapi.topology.ContextAugmentation3: + type: "object" + properties: + topology-context: + description: "Augments the base TAPI Context with TopologyService information" + $ref: "#/definitions/tapi.topology.TopologyContext" + x-augmentation: + prefix: "tapi-topology" + namespace: "urn:onf:otcc:yang:tapi-topology" + tapi.topology.CostCharacteristic: + type: "object" + properties: + cost-value: + type: "string" + description: "The specific cost." + cost-algorithm: + type: "string" + description: "The cost may vary based upon some properties of the TopologicalEntity.\ + \ The rules for the variation are conveyed by the costAlgorithm." + cost-name: + type: "string" + description: "The cost characteristic will related to some aspect of the TopologicalEntity\ + \ (e.g. $ cost, routing weight). This aspect will be conveyed by the costName." + tapi.topology.ForwardingRule: + type: "string" + enum: + - "MAY_FORWARD_ACROSS_GROUP" + - "MUST_FORWARD_ACROSS_GROUP" + - "CANNOT_FORWARD_ACROSS_GROUP" + - "NO_STATEMENT_ON_FORWARDING" + tapi.topology.GetLinkDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getlinkdetails.Output" + tapi.topology.GetNodeDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getnodedetails.Output" + tapi.topology.GetNodeEdgePointDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Output" + tapi.topology.GetTopologyDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.gettopologydetails.Output" + tapi.topology.GetTopologyList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.gettopologylist.Output" + tapi.topology.InterRuleGroup: + allOf: + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + associated-node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + rule: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Rule" + description: "none" + tapi.topology.LatencyCharacteristic: + type: "object" + properties: + traffic-property-name: + type: "string" + description: "The identifier of the specific traffic property to which the\ + \ queuing latency applies." + jitter-characteristic: + type: "string" + description: "High frequency deviation from true periodicity of a signal and\ + \ therefore a small high rate of change of transfer latency.\r\n \ + \ Applies to TDM systems (and not packet)." + fixed-latency-characteristic: + type: "string" + description: "A TopologicalEntity suffers delay caused by the realization\ + \ of the servers (e.g. distance related; FEC encoding etc.) along with some\ + \ client specific processing. This is the total average latency effect of\ + \ the TopologicalEntity" + wander-characteristic: + type: "string" + description: "Low frequency deviation from true periodicity of a signal and\ + \ therefore a small low rate of change of transfer latency.\r\n \ + \ Applies to TDM systems (and not packet)." + queing-latency-characteristic: + type: "string" + description: "The specific queuing latency for the traffic property." + tapi.topology.LayerProtocolTransitionPac: + type: "object" + properties: + transitioned-layer-protocol-name: + type: "array" + description: "Provides the ordered structure of layer protocol transitions\ + \ encapsulated in the TopologicalEntity. The ordering relates to the LinkPort\ + \ role." + items: + type: "string" + tapi.topology.Link: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.LayerProtocolTransitionPac" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - $ref: "#/definitions/tapi.topology.ValidationPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + restoration-policy: + description: "none" + $ref: "#/definitions/tapi.topology.RestorationPolicy" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" + direction: + description: "The directionality of the Link. \r\n Is applicable\ + \ to simple Links where all LinkEnds are BIDIRECTIONAL (the Link will\ + \ be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ + \ \r\n Is not present in more complex cases." + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "The Link object class models effective adjacency between two or\ + \ more ForwardingDomains (FD). " + tapi.topology.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.NepLayerProtocolCapability: + type: "object" + properties: + layer-protocol-qualifier: + type: "string" + description: "none" + number-of-cep-instances: + type: "integer" + format: "int32" + description: "none" + tapi.topology.NetworkTopologyService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.TopologyRef" + description: "none" + tapi.topology.Node: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + encap-topology: + description: "none" + $ref: "#/definitions/tapi.topology.TopologyRef" + node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePoint" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ + \ topological component which is used to effect forwarding of transport characteristic\ + \ information and offers the potential to enable forwarding. \r\n \ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ multiple switch matrices (FDs). " + tapi.topology.NodeEdgePoint: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.common.TerminationPac" + - type: "object" + properties: + link-port-role: + description: "Each LinkEnd of the Link has a role (e.g., symmetric, hub,\ + \ spoke, leaf, root) in the context of the Link with respect to the Link\ + \ function. " + $ref: "#/definitions/tapi.common.PortRole" + mapped-service-interface-point: + type: "array" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load\ + \ balancing/Resilience) should be considered experimental" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + available-cep-layer-protocol: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + link-port-direction: + description: "The orientation of defined flow at the LinkEnd." + $ref: "#/definitions/tapi.common.PortDirection" + description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ + \ termination and adaptation functions of one or more transport layers. \r\ + \n The structure of LTP supports all transport protocols including\ + \ circuit and packet forms." + tapi.topology.NodeEdgePointRef: + allOf: + - $ref: "#/definitions/tapi.topology.NodeRef" + - type: "object" + properties: + node-edge-point-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-edge-point/tapi-topology:uuid" + description: "none" + tapi.topology.NodeRef: + allOf: + - $ref: "#/definitions/tapi.topology.TopologyRef" + - type: "object" + properties: + node-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:uuid" + description: "none" + tapi.topology.NodeRuleGroup: + allOf: + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + inter-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.InterRuleGroup" + rule: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Rule" + composed-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "none" + tapi.topology.NodeRuleGroupRef: + allOf: + - $ref: "#/definitions/tapi.topology.NodeRef" + - type: "object" + properties: + node-rule-group-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-rule-group/tapi-topology:uuid" + description: "none" + tapi.topology.ProtectionType: + type: "string" + enum: + - "NO_PROTECTION" + - "ONE_PLUS_ONE_PROTECTION" + - "ONE_FOR_ONE_PROTECTION" + - "ONE_FOR_N_PROTECTION" + - "M_FOR_N_PROTECTION" + - "ONE_FOR_ONE_BY_N" + tapi.topology.RestorationPolicy: + type: "string" + enum: + - "PER_DOMAIN_RESTORATION" + - "END_TO_END_RESTORATION" + - "NA" + - "DYNAMIC_RESTORATION" + - "PRE_COMPUTED_RESTORATION" + tapi.topology.RiskCharacteristic: + type: "object" + properties: + risk-characteristic-name: + type: "string" + description: "The name of the risk characteristic. The characteristic may\ + \ be related to a specific degree of closeness. \r\n For\ + \ example a particular characteristic may apply to failures that are localized\ + \ (e.g. to one side of a road) where as another characteristic may relate\ + \ to failures that have a broader impact (e.g. both sides of a road that\ + \ crosses a bridge).\r\n Depending upon the importance of\ + \ the traffic being routed different risk characteristics will be evaluated." + risk-identifier-list: + type: "array" + description: "A list of the identifiers of each physical/geographic unit (with\ + \ the specific risk characteristic) that is related to a segment of the\ + \ TopologicalEntity." + items: + type: "string" + tapi.topology.RiskParameterPac: + type: "object" + properties: + risk-characteristic: + type: "array" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + items: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + tapi.topology.Rule: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + override-priority: + type: "integer" + format: "int32" + description: "none" + forwarding-rule: + description: "none" + $ref: "#/definitions/tapi.topology.ForwardingRule" + rule-type: + description: "none" + $ref: "#/definitions/tapi.topology.RuleType" + description: "none" + tapi.topology.RuleType: + type: "string" + enum: + - "FORWARDING" + - "CAPACITY" + - "COST" + - "TIMING" + - "RISK" + - "GROUPING" + tapi.topology.Topology: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + link: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Link" + node: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Node" + boundary-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ + \ topological component which is used to effect forwarding of transport characteristic\ + \ information and offers the potential to enable forwarding. \r\n \ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ multiple switch matrices (FDs). " + tapi.topology.TopologyContext: + type: "object" + properties: + nw-topology-service: + description: "none" + $ref: "#/definitions/tapi.topology.NetworkTopologyService" + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.TopologyRef: + type: "object" + properties: + topology-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:uuid" + tapi.topology.TransferCostPac: + type: "object" + properties: + cost-characteristic: + type: "array" + description: "The list of costs where each cost relates to some aspect of\ + \ the TopologicalEntity." + items: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + tapi.topology.TransferIntegrityPac: + type: "object" + properties: + error-characteristic: + type: "string" + description: "Describes the degree to which the signal propagated can be errored.\ + \ \r\n Applies to TDM systems as the errored signal will\ + \ be propagated and not packet as errored packets will be discarded." + unavailable-time-characteristic: + type: "string" + description: "Describes the duration for which there may be no valid signal\ + \ propagated." + server-integrity-process-characteristic: + type: "string" + description: "Describes the effect of any server integrity enhancement process\ + \ on the characteristics of the TopologicalEntity." + delivery-order-characteristic: + type: "string" + description: "Describes the degree to which packets will be delivered out\ + \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ + \ maintain strict order." + repeat-delivery-characteristic: + type: "string" + description: "Primarily applies to packet systems where a packet may be delivered\ + \ more than once (in fault recovery for example). \r\n It\ + \ can also apply to TDM where several frames may be received twice due to\ + \ switching in a system with a large differential propagation delay." + loss-characteristic: + type: "string" + description: "Describes the acceptable characteristic of lost packets where\ + \ loss may result from discard due to errors or overflow.\r\n \ + \ Applies to packet systems and not TDM (as for TDM errored signals\ + \ are propagated unless grossly errored and overflow/underflow turns into\ + \ timing slips)." + tapi.topology.TransferTimingPac: + type: "object" + properties: + latency-characteristic: + type: "array" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + items: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + tapi.topology.ValidationMechanism: + type: "object" + properties: + layer-protocol-adjacency-validated: + type: "string" + description: "State of validatiion" + validation-mechanism: + type: "string" + description: "Name of mechanism used to validate adjacency" + validation-robustness: + type: "string" + description: "Quality of validation (i.e. how likely is the stated validation\ + \ to be invalid)" + tapi.topology.ValidationPac: + type: "object" + properties: + validation-mechanism: + type: "array" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." + items: + $ref: "#/definitions/tapi.topology.ValidationMechanism" + tapi.topology.getlinkdetails.Input: + type: "object" + properties: + link-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getlinkdetails.Output: + type: "object" + properties: + link: + description: "none" + $ref: "#/definitions/tapi.topology.Link" + tapi.topology.getnodedetails.Input: + type: "object" + properties: + node-id: + type: "string" + description: "UUID of the Node: An identifier that is universally unique within\ + \ an identifier space, where the identifier space is itself globally unique,\ + \ and immutable.\r\n An UUID carries no semantics with\ + \ respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The canonical\ + \ representation uses lowercase characters.\r\n Pattern:\ + \ [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getnodedetails.Output: + type: "object" + properties: + node: + description: "none" + $ref: "#/definitions/tapi.topology.Node" + tapi.topology.getnodeedgepointdetails.Input: + type: "object" + properties: + node-id: + type: "string" + description: "UUID of the parent Node: An identifier that is universally unique\ + \ within an identifier space, where the identifier space is itself globally\ + \ unique, and immutable.\r\n An UUID carries no semantics\ + \ with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The\ + \ canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Node's Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + node-edge-point-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getnodeedgepointdetails.Output: + type: "object" + properties: + node-edge-point: + description: "none" + $ref: "#/definitions/tapi.topology.NodeEdgePoint" + tapi.topology.gettopologydetails.Input: + type: "object" + properties: + topology-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.gettopologydetails.Output: + type: "object" + properties: + topology: + description: "none" + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.gettopologylist.Output: + type: "object" + properties: + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Topology" diff --git a/OAS/tapi-photonic-media@2019-03-31.yaml b/OAS/tapi-photonic-media@2019-03-31.yaml new file mode 100644 index 00000000..8671ef7a --- /dev/null +++ b/OAS/tapi-photonic-media@2019-03-31.yaml @@ -0,0 +1,22178 @@ +--- +swagger: "2.0" +info: + description: "\r\n This module contains TAPI Odu Model definitions.\r\n \ + \ Source: TapiOdu.uml\r\n Copyright (c) 2018 Open Networking Foundation\ + \ (ONF). All rights reserved.\r\n License: This module is distributed under\ + \ the Apache License 2.0\r\n - The TAPI YANG models included in this TAPI\ + \ release are a *normative* part of the TAPI SDK.\r\n - The YANG specifications\ + \ have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG\ + \ mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Notification\ + \ Model definitions.\r\n Source: TapiNotification.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Topology\ + \ Model definitions.\r\n Source: TapiTopology.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI DSR Model\ + \ definitions.\r\n Source: TapiDsr.uml\r\n Copyright (c) 2018 Open\ + \ Networking Foundation (ONF). All rights reserved.\r\n License: This module\ + \ is distributed under the Apache License 2.0\r\n - The TAPI YANG models\ + \ included in this TAPI release are a *normative* part of the TAPI SDK.\r\n \ + \ - The YANG specifications have been generated from the corresponding UML\ + \ model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Common Model\ + \ definitions.\r\n Source: TapiCommon.uml\r\n Copyright (c) 2018\ + \ Open Networking Foundation (ONF). All rights reserved.\r\n License: This\ + \ module is distributed under the Apache License 2.0\r\n - The TAPI YANG\ + \ models included in this TAPI release are a *normative* part of the TAPI SDK.\r\ + \n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Path Computation\ + \ Model definitions.\r\n Source: TapiPathComputation.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Connectivity\ + \ Model definitions.\r\n Source: TapiConnectivity.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI OAM Model\ + \ definitions.\r\n Source: TapiOam.uml\r\n Copyright (c) 2018 Open\ + \ Networking Foundation (ONF). All rights reserved.\r\n License: This module\ + \ is distributed under the Apache License 2.0\r\n - The TAPI YANG models\ + \ included in this TAPI release are a *normative* part of the TAPI SDK.\r\n \ + \ - The YANG specifications have been generated from the corresponding UML\ + \ model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI PhotonicMedia\ + \ Model definitions.\r\n Source: TapiPhotonicMedia.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases." + version: "2.2.0" + title: "tapi-odu,tapi-notification,tapi-topology,tapi-dsr,tapi-common,tapi-path-computation,tapi-connectivity,tapi-oam,tapi-photonic-media\ + \ API" +host: "localhost:1234" +consumes: +- "application/yang-data+json" +produces: +- "application/yang-data+json" +paths: + /data/context/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Context" + description: "none" + parameters: [] + responses: + 200: + description: "tapi.common.Context" + schema: + $ref: "#/definitions/tapi.common.Context" + 400: + description: "Internal error" + post: + tags: + - "tapi-common" + summary: "creates tapi.common.Context" + description: "none" + parameters: + - in: "body" + name: "tapi.common.Context.body-param" + description: "tapi.common.Context to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.Context" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.Context" + description: "none" + parameters: + - in: "body" + name: "tapi.common.Context.body-param" + description: "tapi.common.Context to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.Context" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.Context" + description: "none" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.context.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" + parameters: [] + responses: + 200: + description: "tapi.connectivity.ConnectivityContext" + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.connectivity.context.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" + parameters: + - in: "body" + name: "tapi.connectivity.context.ConnectivityContext.body-param" + description: "tapi.connectivity.ConnectivityContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.connectivity.context.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" + parameters: + - in: "body" + name: "tapi.connectivity.context.ConnectivityContext.body-param" + description: "tapi.connectivity.ConnectivityContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.connectivity.context.ConnectivityContext" + description: "Augments the base TAPI Context with ConnectivityService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/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.Connection" + 400: + description: "Internal error" + /data/context/connectivity-context/connection={uuid}/bounding-node/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.topology.NodeRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connection" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRef" + 400: + description: "Internal error" + ? /data/context/connectivity-context/connection={uuid}/connection-end-point={topology-uuid},{node-uuid},{node-edge-point-uuid},{connection-end-point-uuid}/ + : get: + tags: + - "tapi-connectivity" + 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.ConnectionEndPointRef" + 400: + description: "Internal error" + /data/context/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.ConnectionRef" + 400: + description: "Internal error" + /data/context/connectivity-context/connection={uuid}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of 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.NameAndValue" + 400: + description: "Internal error" + /data/context/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.Route" + 400: + description: "Internal error" + ? /data/context/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.ConnectionEndPointRef" + 400: + description: "Internal error" + /data/context/connectivity-context/connection={uuid}/route={local-id}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of 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.NameAndValue" + 400: + description: "Internal error" + /data/context/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.LinkRef" + 400: + description: "Internal error" + /data/context/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.SwitchControl" + 400: + description: "Internal error" + /data/context/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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n 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.NameAndValue" + 400: + description: "Internal error" + ? /data/context/connectivity-context/connection={uuid}/switch-control={switch-control-uuid}/sub-switch-control={connection-uuid},{sub-switch-control-switch-control-uuid}/ + : get: + tags: + - "tapi-connectivity" + 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.SwitchControlRef" + 400: + description: "Internal error" + /data/context/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.Switch" + 400: + description: "Internal error" + /data/context/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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n 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.NameAndValue" + 400: + description: "Internal error" + ? /data/context/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.ConnectionEndPointRef" + 400: + description: "Internal error" + ? /data/context/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.RouteRef" + 400: + description: "Internal error" + /data/context/connectivity-context/connectivity-service/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.connectivity.connectivitycontext.ConnectivityService" + description: "none" + parameters: + - in: "body" + name: "tapi.connectivity.connectivitycontext.ConnectivityService.body-param" + description: "tapi.connectivity.connectivitycontext.ConnectivityService to\ + \ be added to list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.connectivitycontext.ConnectivityService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.connectivitycontext.ConnectivityService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.connectivitycontext.ConnectivityService" + schema: + $ref: "#/definitions/tapi.connectivity.connectivitycontext.ConnectivityService" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.connectivity.connectivitycontext.ConnectivityService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.connectivitycontext.ConnectivityService.body-param" + description: "tapi.connectivity.connectivitycontext.ConnectivityService to\ + \ be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.connectivitycontext.ConnectivityService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.connectivity.connectivitycontext.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/context/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.ConnectionRef" + 400: + description: "Internal error" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.ConnectivityConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.ConnectivityConstraint" + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.connectivity.ConnectivityConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ConnectivityConstraint.body-param" + description: "tapi.connectivity.ConnectivityConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.connectivity.ConnectivityConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ConnectivityConstraint.body-param" + description: "tapi.connectivity.ConnectivityConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.connectivity.ConnectivityConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.ConnectivityServiceRef" + 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.ConnectivityServiceRef" + 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.ConnectivityServiceRef" + 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/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.ConnectivityServiceRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.ConnectivityServiceRef" + 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.ConnectivityServiceRef" + 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/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.Capacity" + 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.Capacity" + 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.Capacity" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.CapacityValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-connectivity" + 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.CapacityValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/connectivity-constraint/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.TimeRange" + 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.TimeRange" + 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.TimeRange" + 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/context/connectivity-context/connectivity-service={uuid}/end-point/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.connectivity.connectivityservice.EndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.connectivityservice.EndPoint.body-param" + description: "tapi.connectivity.connectivityservice.EndPoint to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.connectivityservice.EndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.connectivityservice.EndPoint" + schema: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.connectivity.connectivityservice.EndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.connectivityservice.EndPoint.body-param" + description: "tapi.connectivity.connectivityservice.EndPoint to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.connectivity.connectivityservice.EndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/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.Capacity" + 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.Capacity" + 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.Capacity" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/capacity/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.CapacityValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-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.CapacityValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/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.ConnectionEndPointRef" + 400: + description: "Internal error" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-connectivity-service-end-point-spec/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.MediaChannelConnectivityServiceEndPointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.MediaChannelConnectivityServiceEndPointSpec" + schema: + $ref: "#/definitions/tapi.photonic.media.MediaChannelConnectivityServiceEndPointSpec" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.MediaChannelConnectivityServiceEndPointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.MediaChannelConnectivityServiceEndPointSpec.body-param" + description: "tapi.photonic.media.MediaChannelConnectivityServiceEndPointSpec\ + \ to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.MediaChannelConnectivityServiceEndPointSpec" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.MediaChannelConnectivityServiceEndPointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.MediaChannelConnectivityServiceEndPointSpec.body-param" + description: "tapi.photonic.media.MediaChannelConnectivityServiceEndPointSpec\ + \ to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.MediaChannelConnectivityServiceEndPointSpec" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.MediaChannelConnectivityServiceEndPointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-connectivity-service-end-point-spec/mc-config/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.MediaChannelConfigPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.MediaChannelConfigPac" + schema: + $ref: "#/definitions/tapi.photonic.media.MediaChannelConfigPac" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.MediaChannelConfigPac" + 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.photonic.media.MediaChannelConfigPac.body-param" + description: "tapi.photonic.media.MediaChannelConfigPac to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.MediaChannelConfigPac" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.MediaChannelConfigPac" + 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.photonic.media.MediaChannelConfigPac.body-param" + description: "tapi.photonic.media.MediaChannelConfigPac to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.MediaChannelConfigPac" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.MediaChannelConfigPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-connectivity-service-end-point-spec/mc-config/spectrum/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.SpectrumBand" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.SpectrumBand" + schema: + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.SpectrumBand" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.SpectrumBand.body-param" + description: "tapi.photonic.media.SpectrumBand to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.SpectrumBand" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.SpectrumBand.body-param" + description: "tapi.photonic.media.SpectrumBand to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.SpectrumBand" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-connectivity-service-end-point-spec/mc-config/spectrum/frequency-constraint/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.FrequencyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.FrequencyConstraint" + schema: + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.FrequencyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.FrequencyConstraint.body-param" + description: "tapi.photonic.media.FrequencyConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.FrequencyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.FrequencyConstraint.body-param" + description: "tapi.photonic.media.FrequencyConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.FrequencyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-connectivity-service-end-point-spec/power-management-config/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerManagementConfigPac" + description: "This parameters shall be used to configure the expected\r\n \ + \ and intended (desired) power levels at the endpoints of the\ + \ media\r\n Channel connectivity service. These parameters\ + \ are dependent of the\r\n related OTSi power-management capabilities\ + \ exposed at the SIPs" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.PowerManagementConfigPac" + schema: + $ref: "#/definitions/tapi.photonic.media.PowerManagementConfigPac" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.PowerManagementConfigPac" + description: "This parameters shall be used to configure the expected\r\n \ + \ and intended (desired) power levels at the endpoints of the\ + \ media\r\n Channel connectivity service. These parameters\ + \ are dependent of the\r\n related OTSi power-management capabilities\ + \ exposed at the SIPs" + parameters: + - name: "uuid" + in: "path" + 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.photonic.media.PowerManagementConfigPac.body-param" + description: "tapi.photonic.media.PowerManagementConfigPac to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerManagementConfigPac" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.PowerManagementConfigPac" + description: "This parameters shall be used to configure the expected\r\n \ + \ and intended (desired) power levels at the endpoints of the\ + \ media\r\n Channel connectivity service. These parameters\ + \ are dependent of the\r\n related OTSi power-management capabilities\ + \ exposed at the SIPs" + parameters: + - name: "uuid" + in: "path" + 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.photonic.media.PowerManagementConfigPac.body-param" + description: "tapi.photonic.media.PowerManagementConfigPac to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerManagementConfigPac" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.PowerManagementConfigPac" + description: "This parameters shall be used to configure the expected\r\n \ + \ and intended (desired) power levels at the endpoints of the\ + \ media\r\n Channel connectivity service. These parameters\ + \ are dependent of the\r\n related OTSi power-management capabilities\ + \ exposed at the SIPs" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-connectivity-service-end-point-spec/power-management-config/expected-maximum-input-power/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the maximum input power\r\ + \n being received at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.PowerProperties" + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the maximum input power\r\ + \n being received at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." + parameters: + - name: "uuid" + in: "path" + 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.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the maximum input power\r\ + \n being received at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." + parameters: + - name: "uuid" + in: "path" + 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.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the maximum input power\r\ + \n being received at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-connectivity-service-end-point-spec/power-management-config/expected-minimum-input-power/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the minimum input power\r\ + \n being received at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.PowerProperties" + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the minimum input power\r\ + \n being received at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." + parameters: + - name: "uuid" + in: "path" + 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.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the minimum input power\r\ + \n being received at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." + parameters: + - name: "uuid" + in: "path" + 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.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the minimum input power\r\ + \n being received at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-connectivity-service-end-point-spec/power-management-config/intended-maximum-output-power/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the maximum output power\r\ + \n desired at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.PowerProperties" + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the maximum output power\r\ + \n desired at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." + parameters: + - name: "uuid" + in: "path" + 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.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the maximum output power\r\ + \n desired at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." + parameters: + - name: "uuid" + in: "path" + 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.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the maximum output power\r\ + \n desired at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/media-channel-connectivity-service-end-point-spec/power-management-config/intended-minimum-output-power/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the minimum output power\r\ + \n desired at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.PowerProperties" + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the minimum output power\r\ + \n desired at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." + parameters: + - name: "uuid" + in: "path" + 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.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the minimum output power\r\ + \n desired at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." + parameters: + - name: "uuid" + in: "path" + 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.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.PowerProperties" + description: "This parameter shall be used to specify the minimum output power\r\ + \n desired at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/odu-connectivity-service-end-point-spec/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduConnectivityServiceEndPointSpec" + 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.odu.OduConnectivityServiceEndPointSpec" + schema: + $ref: "#/definitions/tapi.odu.OduConnectivityServiceEndPointSpec" + 400: + description: "Internal error" + post: + tags: + - "tapi-odu" + summary: "creates tapi.odu.OduConnectivityServiceEndPointSpec" + 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.odu.OduConnectivityServiceEndPointSpec.body-param" + description: "tapi.odu.OduConnectivityServiceEndPointSpec to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.odu.OduConnectivityServiceEndPointSpec" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-odu" + summary: "creates or updates tapi.odu.OduConnectivityServiceEndPointSpec" + 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.odu.OduConnectivityServiceEndPointSpec.body-param" + description: "tapi.odu.OduConnectivityServiceEndPointSpec to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.odu.OduConnectivityServiceEndPointSpec" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-odu" + summary: "removes tapi.odu.OduConnectivityServiceEndPointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/odu-connectivity-service-end-point-spec/accepted-payload-type/ + : get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduPayloadType" + description: "This attribute is applicable when the ODU CTP object instance\ + \ represents a lower order ODU CTP Sink at the client layer of the ODUP/ODU[i]j\ + \ or ODUP/ODUj-21 adaptation function. \r\n This attribute\ + \ is a 2-digit Hex code that indicates the new accepted payload type.\r\n\ + \ Valid values are defined in Table 15-8 of ITU-T Recommendation\ + \ G.709 with one additional value UN_INTERPRETABLE." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduPayloadType" + schema: + $ref: "#/definitions/tapi.odu.OduPayloadType" + 400: + description: "Internal error" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/: + get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" + schema: + $ref: "#/definitions/tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" + 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.photonic.media.OtsiConnectivityServiceEndPointSpec.body-param" + description: "tapi.photonic.media.OtsiConnectivityServiceEndPointSpec to be\ + \ added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" + 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.photonic.media.OtsiConnectivityServiceEndPointSpec.body-param" + description: "tapi.photonic.media.OtsiConnectivityServiceEndPointSpec to be\ + \ added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/otsi-config/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.OtsiTerminationConfigPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.OtsiTerminationConfigPac" + schema: + $ref: "#/definitions/tapi.photonic.media.OtsiTerminationConfigPac" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.OtsiTerminationConfigPac" + 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.photonic.media.OtsiTerminationConfigPac.body-param" + description: "tapi.photonic.media.OtsiTerminationConfigPac to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.OtsiTerminationConfigPac" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.OtsiTerminationConfigPac" + 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.photonic.media.OtsiTerminationConfigPac.body-param" + description: "tapi.photonic.media.OtsiTerminationConfigPac to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.OtsiTerminationConfigPac" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.OtsiTerminationConfigPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/otsi-config/application-identifier/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.ApplicationIdentifier" + description: "This attribute indicates the selected Application Identifier." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.ApplicationIdentifier" + schema: + $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifier" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.ApplicationIdentifier" + description: "This attribute indicates the selected Application Identifier." + 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.photonic.media.ApplicationIdentifier.body-param" + description: "tapi.photonic.media.ApplicationIdentifier to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifier" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.ApplicationIdentifier" + description: "This attribute indicates the selected Application Identifier." + 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.photonic.media.ApplicationIdentifier.body-param" + description: "tapi.photonic.media.ApplicationIdentifier to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifier" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.ApplicationIdentifier" + description: "This attribute indicates the selected Application Identifier." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/otsi-config/central-frequency/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.CentralFrequency" + description: "The central frequency of the laser. It is the oscillation frequency\ + \ of the corresponding electromagnetic wave" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.CentralFrequency" + schema: + $ref: "#/definitions/tapi.photonic.media.CentralFrequency" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.CentralFrequency" + description: "The central frequency of the laser. It is the oscillation frequency\ + \ of the corresponding electromagnetic wave" + parameters: + - name: "uuid" + in: "path" + 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.photonic.media.CentralFrequency.body-param" + description: "tapi.photonic.media.CentralFrequency to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.CentralFrequency" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.CentralFrequency" + description: "The central frequency of the laser. It is the oscillation frequency\ + \ of the corresponding electromagnetic wave" + parameters: + - name: "uuid" + in: "path" + 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.photonic.media.CentralFrequency.body-param" + description: "tapi.photonic.media.CentralFrequency to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.CentralFrequency" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.CentralFrequency" + description: "The central frequency of the laser. It is the oscillation frequency\ + \ of the corresponding electromagnetic wave" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/otsi-config/central-frequency/frequency-constraint/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.FrequencyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.FrequencyConstraint" + schema: + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.FrequencyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.FrequencyConstraint.body-param" + description: "tapi.photonic.media.FrequencyConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.FrequencyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.FrequencyConstraint.body-param" + description: "tapi.photonic.media.FrequencyConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.FrequencyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/otsi-config/spectrum/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.SpectrumBand" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.SpectrumBand" + schema: + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.SpectrumBand" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.SpectrumBand.body-param" + description: "tapi.photonic.media.SpectrumBand to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.SpectrumBand" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.SpectrumBand.body-param" + description: "tapi.photonic.media.SpectrumBand to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.SpectrumBand" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/otsi-config/spectrum/frequency-constraint/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.FrequencyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.FrequencyConstraint" + schema: + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.FrequencyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.FrequencyConstraint.body-param" + description: "tapi.photonic.media.FrequencyConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.FrequencyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.FrequencyConstraint.body-param" + description: "tapi.photonic.media.FrequencyConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.FrequencyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/otsi-connectivity-service-end-point-spec/otsi-config/transmit-power/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerProperties" + description: "Transmit power as requested." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.PowerProperties" + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.PowerProperties" + description: "Transmit power as requested." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.PowerProperties" + description: "Transmit power as requested." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.PowerProperties" + description: "Transmit power as requested." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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/context/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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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/context/connectivity-context/connectivity-service={uuid}/end-point={local-id}/server-connectivity-service-end-point/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of 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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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.ConnectivityServiceEndPointRef" + 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/context/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.ServiceInterfacePointRef" + 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.ServiceInterfacePointRef" + 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.ServiceInterfacePointRef" + 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/context/connectivity-context/connectivity-service={uuid}/name/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/resilience-constraint/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.ResilienceConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.ResilienceConstraint" + schema: + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.connectivity.ResilienceConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ResilienceConstraint.body-param" + description: "tapi.connectivity.ResilienceConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.connectivity.ResilienceConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ResilienceConstraint.body-param" + description: "tapi.connectivity.ResilienceConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.connectivity.ResilienceConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.RoutingConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/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.CostCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + 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.CostCharacteristic" + 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/context/connectivity-context/connectivity-service={uuid}/routing-constraint/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.LatencyCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-connectivity" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + 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.LatencyCharacteristic" + 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/context/connectivity-context/connectivity-service={uuid}/routing-constraint/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.RiskCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/connectivity-context/connectivity-service={uuid}/routing-constraint/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.RiskCharacteristic" + 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.RiskCharacteristic" + 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/context/connectivity-context/connectivity-service={uuid}/topology-constraint/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.path.computation.TopologyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.path.computation.TopologyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.TopologyConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.path.computation.TopologyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.path.computation.TopologyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/name/: + post: + tags: + - "tapi-connectivity" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/connectivity-context/connectivity-service={uuid}/topology-constraint={local-id}/name={value-name}/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-connectivity" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-connectivity" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of connectivity-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/name/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] + responses: + 200: + description: "tapi.notification.context.NotificationContext" + schema: + $ref: "#/definitions/tapi.notification.context.NotificationContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: + - in: "body" + name: "tapi.notification.context.NotificationContext.body-param" + description: "tapi.notification.context.NotificationContext to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.notification.context.NotificationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: + - in: "body" + name: "tapi.notification.context.NotificationContext.body-param" + description: "tapi.notification.context.NotificationContext to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.context.NotificationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.context.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - in: "body" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NotificationSubscriptionService" + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/name/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/notification-channel/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationChannel" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NotificationChannel" + schema: + $ref: "#/definitions/tapi.notification.NotificationChannel" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.Notification" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.Notification" + schema: + $ref: "#/definitions/tapi.notification.Notification" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.SubscriptionFilter" + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + 400: + description: "Internal error" + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notification={uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.notificationcontext.Notification" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.notificationcontext.Notification" + schema: + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/additional-info={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/alarm-info/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.AlarmInfo" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.AlarmInfo" + schema: + $ref: "#/definitions/tapi.oam.AlarmInfo" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.TcaInfo" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.TcaInfo" + schema: + $ref: "#/definitions/tapi.oam.TcaInfo" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/oam-job/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamJobRef" + description: "MEF 35.1\r\n Identification of the PM Session for\ + \ which the TCA Function was configured." + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamJobRef" + schema: + $ref: "#/definitions/tapi.oam.OamJobRef" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.ThresholdParameter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.ThresholdParameter" + schema: + $ref: "#/definitions/tapi.oam.ThresholdParameter" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-above-thrs/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-below-thrs/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/tca-info/threshold-parameter/pm-parameter-clear-thrs/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + /data/context/oam-context/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.context.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: [] + responses: + 200: + description: "tapi.oam.context.OamContext" + schema: + $ref: "#/definitions/tapi.oam.context.OamContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.context.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: + - in: "body" + name: "tapi.oam.context.OamContext.body-param" + description: "tapi.oam.context.OamContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.context.OamContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.context.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: + - in: "body" + name: "tapi.oam.context.OamContext.body-param" + description: "tapi.oam.context.OamContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.context.OamContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.context.OamContext" + description: "Augments the base TAPI Context with OamService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/meg={uuid}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.oamcontext.Meg" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.oamcontext.Meg" + schema: + $ref: "#/definitions/tapi.oam.oamcontext.Meg" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.meg.Mep" + description: "1. ME may have 0 MEPs (case of transit domains where at least\ + \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case of edge\ + \ domaind, where the peer MEP is ouside the managed domain)\r\n \ + \ 3. ME may have 2 MEPs" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.meg.Mep" + schema: + $ref: "#/definitions/tapi.oam.meg.Mep" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduMepSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduMepSpec" + schema: + $ref: "#/definitions/tapi.odu.OduMepSpec" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/odu-defect/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduDefectPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduDefectPac" + schema: + $ref: "#/definitions/tapi.odu.OduDefectPac" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/odu-mep/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduMepPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduMepPac" + schema: + $ref: "#/definitions/tapi.odu.OduMepPac" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/odu-mep/deg-thr/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.DegThr" + description: "This attribute indicates the threshold level for declaring a performance\ + \ monitoring (PM) Second to be bad. The value of the threshold can be provisioned\ + \ in terms of number of errored blocks or in terms of percentage of errored\ + \ blocks. For percentage-based specification, in order to support provision\ + \ of less than 1%, the specification consists of two fields. The first field\ + \ indicates the granularity of percentage. For examples, in 1%, in 0.1%, or\ + \ in 0.01%, etc. The second field indicates the multiple of the granularity.\ + \ For number of errored block based, the value is a positive integer." + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.DegThr" + schema: + $ref: "#/definitions/tapi.odu.DegThr" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/odu-ncm/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduNcmPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduNcmPac" + schema: + $ref: "#/definitions/tapi.odu.OduNcmPac" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/odu-pm/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduPmPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduPmPac" + schema: + $ref: "#/definitions/tapi.odu.OduPmPac" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/odu-pm/uas/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.UasChoice" + description: "UnAvailable Second" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.UasChoice" + schema: + $ref: "#/definitions/tapi.odu.UasChoice" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mep={local-id}/odu-mep-spec/odu-tcm/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduTcmMepPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduTcmMepPac" + schema: + $ref: "#/definitions/tapi.odu.OduTcmMepPac" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mip={local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.meg.Mip" + description: "ME may 0, 1, or more MIPs" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.meg.Mip" + schema: + $ref: "#/definitions/tapi.oam.meg.Mip" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mip={local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduMipSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduMipSpec" + schema: + $ref: "#/definitions/tapi.odu.OduMipSpec" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-defect/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduDefectPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduDefectPac" + schema: + $ref: "#/definitions/tapi.odu.OduDefectPac" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-mip/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduMipPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduMipPac" + schema: + $ref: "#/definitions/tapi.odu.OduMipPac" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-mip/deg-thr/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.DegThr" + description: "This attribute indicates the threshold level for declaring a performance\ + \ monitoring (PM) Second to be bad. The value of the threshold can be provisioned\ + \ in terms of number of errored blocks or in terms of percentage of errored\ + \ blocks. For percentage-based specification, in order to support provision\ + \ of less than 1%, the specification consists of two fields. The first field\ + \ indicates the granularity of percentage. For examples, in 1%, in 0.1%, or\ + \ in 0.01%, etc. The second field indicates the multiple of the granularity.\ + \ For number of errored block based, the value is a positive integer." + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.DegThr" + schema: + $ref: "#/definitions/tapi.odu.DegThr" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-ncm/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduNcmPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduNcmPac" + schema: + $ref: "#/definitions/tapi.odu.OduNcmPac" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-pm/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduPmPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduPmPac" + schema: + $ref: "#/definitions/tapi.odu.OduPmPac" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-pm/uas/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.UasChoice" + description: "UnAvailable Second" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.UasChoice" + schema: + $ref: "#/definitions/tapi.odu.UasChoice" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/mip={local-id}/odu-mip-spec/odu-tcm/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduTcmMipPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduTcmMipPac" + schema: + $ref: "#/definitions/tapi.odu.OduTcmMipPac" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/oam-context/meg={uuid}/odu-meg-spec/: + get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduMegSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of meg" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduMegSpec" + schema: + $ref: "#/definitions/tapi.odu.OduMegSpec" + 400: + description: "Internal error" + /data/context/oam-context/oam-job/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamJob" + description: "none" + parameters: + - in: "body" + name: "tapi.oam.OamJob.body-param" + description: "tapi.oam.OamJob to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamJob" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-job={uuid}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamJob" + schema: + $ref: "#/definitions/tapi.oam.OamJob" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamJob.body-param" + description: "tapi.oam.OamJob to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamJob" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamJob" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.CurrentData" + description: "Granularity period of the CurrentData identifies the specific\ + \ CurrentData instance in the scope of this OamJob.\r\n For\ + \ example, typically at least\r\n one 15min and\r\n \ + \ one 24hr;\r\n optionally one additional configurable\ + \ (< 15min)" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.CurrentData" + schema: + $ref: "#/definitions/tapi.oam.CurrentData" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/elapsed-time/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimeInterval" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimeInterval" + schema: + $ref: "#/definitions/tapi.common.TimeInterval" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/elapsed-time/period={unit}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "unit" + in: "path" + description: "Id of period" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimePeriod" + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.HistoryData" + description: "in case of 24hr Current Data, at least 1 History Data.\r\n \ + \ In case of 15min Current Data, at least 16 History Data.\r\n\ + \ In case of <15min, the number of History Data shall be able\ + \ to cover a span of 4 hours." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.HistoryData" + schema: + $ref: "#/definitions/tapi.oam.HistoryData" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/pm-data-pac/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmDataPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmDataPac" + schema: + $ref: "#/definitions/tapi.oam.PmDataPac" + 400: + description: "Internal error" + ? /data/context/oam-context/oam-job={uuid}/current-data={local-id}/history-data={history-data-local-id}/pm-data-pac/granularity-period/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "history-data-local-id" + in: "path" + description: "Id of history-data" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimePeriod" + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/pm-data-pac/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmDataPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmDataPac" + schema: + $ref: "#/definitions/tapi.oam.PmDataPac" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/current-data={local-id}/pm-data-pac/granularity-period/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of current-data" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimePeriod" + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + 400: + description: "Internal error" + /data/context/oam-context/oam-job={uuid}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-job={uuid}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/oam-profile/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamProfileRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamProfileRef" + schema: + $ref: "#/definitions/tapi.oam.OamProfileRef" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamProfileRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamProfileRef.body-param" + description: "tapi.oam.OamProfileRef to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfileRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamProfileRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamProfileRef.body-param" + description: "tapi.oam.OamProfileRef to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfileRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamProfileRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamServicePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamServicePointRef.body-param" + description: "tapi.oam.OamServicePointRef to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamServicePointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-job={uuid}/oam-service-point={oam-service-uuid},{oam-service-point-local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamServicePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "oam-service-uuid" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "oam-service-point-local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamServicePointRef" + schema: + $ref: "#/definitions/tapi.oam.OamServicePointRef" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamServicePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "oam-service-uuid" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "oam-service-point-local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamServicePointRef.body-param" + description: "tapi.oam.OamServicePointRef to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamServicePointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamServicePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - name: "oam-service-uuid" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "oam-service-point-local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-job={uuid}/schedule/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimeRange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimeRange" + schema: + $ref: "#/definitions/tapi.common.TimeRange" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.TimeRange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.TimeRange" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.TimeRange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + - in: "body" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.TimeRange" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.TimeRange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-job" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamProfile" + description: "none" + parameters: + - in: "body" + name: "tapi.oam.OamProfile.body-param" + description: "tapi.oam.OamProfile to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfile" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamProfile" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamProfile" + schema: + $ref: "#/definitions/tapi.oam.OamProfile" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamProfile" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamProfile.body-param" + description: "tapi.oam.OamProfile to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamProfile" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamProfile" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.PmThresholdData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmThresholdData.body-param" + description: "tapi.oam.PmThresholdData to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmThresholdData" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmThresholdData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmThresholdData" + schema: + $ref: "#/definitions/tapi.oam.PmThresholdData" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.PmThresholdData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmThresholdData.body-param" + description: "tapi.oam.PmThresholdData to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmThresholdData" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.PmThresholdData" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/granularity-period/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimePeriod" + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - in: "body" + name: "tapi.common.TimePeriod.body-param" + description: "tapi.common.TimePeriod to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - in: "body" + name: "tapi.common.TimePeriod.body-param" + description: "tapi.common.TimePeriod to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.TimePeriod" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.TimePeriod" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.ThresholdParameter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - in: "body" + name: "tapi.oam.ThresholdParameter.body-param" + description: "tapi.oam.ThresholdParameter to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.ThresholdParameter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.ThresholdParameter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.ThresholdParameter" + schema: + $ref: "#/definitions/tapi.oam.ThresholdParameter" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.ThresholdParameter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.ThresholdParameter.body-param" + description: "tapi.oam.ThresholdParameter to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.ThresholdParameter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.ThresholdParameter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-above-thrs/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-below-thrs/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/oam-context/oam-profile={uuid}/pm-threshold-data={local-id}/threshold-parameter={pm-parameter-name},{threshold-location}/pm-parameter-clear-thrs/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.PmParameterValue" + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - in: "body" + name: "tapi.oam.PmParameterValue.body-param" + description: "tapi.oam.PmParameterValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.PmParameterValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.PmParameterValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-profile" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of pm-threshold-data" + required: true + type: "string" + - name: "pm-parameter-name" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + - name: "threshold-location" + in: "path" + description: "Id of threshold-parameter" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamService" + description: "none" + parameters: + - in: "body" + name: "tapi.oam.OamService.body-param" + description: "tapi.oam.OamService to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-service={uuid}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamService" + schema: + $ref: "#/definitions/tapi.oam.OamService" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamService.body-param" + description: "tapi.oam.OamService to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/meg/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MegRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MegRef" + schema: + $ref: "#/definitions/tapi.oam.MegRef" + 400: + description: "Internal error" + /data/context/oam-context/oam-service={uuid}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-service={uuid}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.oam.OamServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamServicePoint.body-param" + description: "tapi.oam.OamServicePoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamServicePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.OamServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.OamServicePoint" + schema: + $ref: "#/definitions/tapi.oam.OamServicePoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.oam.OamServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.oam.OamServicePoint.body-param" + description: "tapi.oam.OamServicePoint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.oam.OamServicePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.oam.OamServicePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/connectivity-service-end-point/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.ConnectivityServiceEndPointRef" + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.connectivity.ConnectivityServiceEndPointRef.body-param" + description: "tapi.connectivity.ConnectivityServiceEndPointRef to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.connectivity.ConnectivityServiceEndPointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/mep/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MepRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MepRef" + schema: + $ref: "#/definitions/tapi.oam.MepRef" + 400: + description: "Internal error" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/mip/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MipRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MipRef" + schema: + $ref: "#/definitions/tapi.oam.MipRef" + 400: + description: "Internal error" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/name/: + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/name={value-name}/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/oam-context/oam-service={uuid}/oam-service-point={local-id}/service-interface-point/: + get: + tags: + - "tapi-oam" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePointRef" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 400: + description: "Internal error" + post: + tags: + - "tapi-oam" + summary: "creates tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-oam" + summary: "creates or updates tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.ServiceInterfacePointRef.body-param" + description: "tapi.common.ServiceInterfacePointRef to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-oam" + summary: "removes tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of oam-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of oam-service-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: [] + responses: + 200: + description: "tapi.path.computation.PathComputationContext" + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: + - in: "body" + name: "tapi.path.computation.PathComputationContext.body-param" + description: "tapi.path.computation.PathComputationContext to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: + - in: "body" + name: "tapi.path.computation.PathComputationContext.body-param" + description: "tapi.path.computation.PathComputationContext to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.path.computation.PathComputationContext" + description: "Augments the base TAPI Context with PathComputationService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathComputationService" + description: "none" + parameters: + - in: "body" + name: "tapi.path.computation.PathComputationService.body-param" + description: "tapi.path.computation.PathComputationService to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathComputationService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.PathComputationService" + schema: + $ref: "#/definitions/tapi.path.computation.PathComputationService" + 400: + description: "Internal error" + 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.PathComputationService" + 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/context/path-computation-context/path-comp-service={uuid}/end-point/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.PathServiceEndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.PathServiceEndPoint.body-param" + description: "tapi.path.computation.PathServiceEndPoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathServiceEndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.PathServiceEndPoint" + schema: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-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.PathServiceEndPoint" + 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/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/capacity/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of 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.Capacity" + 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.Capacity" + 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.Capacity" + 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/context/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.CapacityValue" + 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.CapacityValue" + 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.CapacityValue" + 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/context/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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/end-point={local-id}/service-interface-point/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePointRef" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 400: + description: "Internal error" + post: + tags: + - "tapi-path-computation" + 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.ServiceInterfacePointRef" + 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.ServiceInterfacePointRef" + 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/context/path-computation-context/path-comp-service={uuid}/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/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.PathObjectiveFunction" + 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.PathObjectiveFunction" + 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.PathObjectiveFunction" + 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/context/path-computation-context/path-comp-service={uuid}/objective-function/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/objective-function/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/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.PathOptimizationConstraint" + 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.PathOptimizationConstraint" + 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.PathOptimizationConstraint" + 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/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/optimization-constraint/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/path={path-uuid}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.PathRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "path-uuid" + in: "path" + description: "Id of path" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.PathRef" + schema: + $ref: "#/definitions/tapi.path.computation.PathRef" + 400: + description: "Internal error" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.RoutingConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + 400: + description: "Internal error" + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.RoutingConstraint.body-param" + description: "tapi.path.computation.RoutingConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.path.computation.RoutingConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - in: "body" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + 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.CostCharacteristic" + 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/context/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.LatencyCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-path-computation" + 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.LatencyCharacteristic" + 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.LatencyCharacteristic" + 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/context/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.RiskCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/path-computation-context/path-comp-service={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-path-computation" + 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.RiskCharacteristic" + 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.RiskCharacteristic" + 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/context/path-computation-context/path-comp-service={uuid}/topology-constraint/: + 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.TopologyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/: + 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" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + responses: + 200: + description: "tapi.path.computation.TopologyConstraint" + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + 400: + description: "Internal error" + put: + tags: + - "tapi-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" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.path.computation.TopologyConstraint.body-param" + description: "tapi.path.computation.TopologyConstraint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object 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" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/name/: + post: + tags: + - "tapi-path-computation" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/path-computation-context/path-comp-service={uuid}/topology-constraint={local-id}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-path-computation" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-path-computation" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path-comp-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of topology-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/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.Path" + 400: + description: "Internal error" + /data/context/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.LinkRef" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/name={value-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/: + get: + tags: + - "tapi-path-computation" + 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.RoutingConstraint" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-path-computation" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of path" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-path-computation" + 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.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/path-computation-context/path={uuid}/routing-constraint/risk-diversity-characteristic={risk-characteristic-name}/: + get: + tags: + - "tapi-path-computation" + 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.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/service-interface-point/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.context.ServiceInterfacePoint" + description: "none" + parameters: + - in: "body" + name: "tapi.common.context.ServiceInterfacePoint.body-param" + description: "tapi.common.context.ServiceInterfacePoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.context.ServiceInterfacePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/service-interface-point={uuid}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.context.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.context.ServiceInterfacePoint" + schema: + $ref: "#/definitions/tapi.common.context.ServiceInterfacePoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.context.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.context.ServiceInterfacePoint.body-param" + description: "tapi.common.context.ServiceInterfacePoint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.context.ServiceInterfacePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.context.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/available-capacity/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/: + get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + schema: + $ref: "#/definitions/tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.MediaChannelServiceInterfacePointSpec.body-param" + description: "tapi.photonic.media.MediaChannelServiceInterfacePointSpec to\ + \ be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.MediaChannelServiceInterfacePointSpec.body-param" + description: "tapi.photonic.media.MediaChannelServiceInterfacePointSpec to\ + \ be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/mc-pool/: + get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.MediaChannelPoolCapabilityPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.MediaChannelPoolCapabilityPac" + schema: + $ref: "#/definitions/tapi.photonic.media.MediaChannelPoolCapabilityPac" + 400: + description: "Internal error" + ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/mc-pool/available-spectrum={upper-frequency},{lower-frequency}/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.SpectrumBand" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "upper-frequency" + in: "path" + description: "Id of available-spectrum" + required: true + type: "integer" + format: "int32" + - name: "lower-frequency" + in: "path" + description: "Id of available-spectrum" + required: true + type: "integer" + format: "int32" + responses: + 200: + description: "tapi.photonic.media.SpectrumBand" + schema: + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + 400: + description: "Internal error" + ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/mc-pool/available-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.FrequencyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "upper-frequency" + in: "path" + description: "Id of available-spectrum" + required: true + type: "integer" + format: "int32" + - name: "lower-frequency" + in: "path" + description: "Id of available-spectrum" + required: true + type: "integer" + format: "int32" + responses: + 200: + description: "tapi.photonic.media.FrequencyConstraint" + schema: + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + 400: + description: "Internal error" + ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/mc-pool/occupied-spectrum={upper-frequency},{lower-frequency}/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.SpectrumBand" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "upper-frequency" + in: "path" + description: "Id of occupied-spectrum" + required: true + type: "integer" + format: "int32" + - name: "lower-frequency" + in: "path" + description: "Id of occupied-spectrum" + required: true + type: "integer" + format: "int32" + responses: + 200: + description: "tapi.photonic.media.SpectrumBand" + schema: + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + 400: + description: "Internal error" + ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/mc-pool/occupied-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.FrequencyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "upper-frequency" + in: "path" + description: "Id of occupied-spectrum" + required: true + type: "integer" + format: "int32" + - name: "lower-frequency" + in: "path" + description: "Id of occupied-spectrum" + required: true + type: "integer" + format: "int32" + responses: + 200: + description: "tapi.photonic.media.FrequencyConstraint" + schema: + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + 400: + description: "Internal error" + ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/mc-pool/supportable-spectrum={upper-frequency},{lower-frequency}/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.SpectrumBand" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "upper-frequency" + in: "path" + description: "Id of supportable-spectrum" + required: true + type: "integer" + format: "int32" + - name: "lower-frequency" + in: "path" + description: "Id of supportable-spectrum" + required: true + type: "integer" + format: "int32" + responses: + 200: + description: "tapi.photonic.media.SpectrumBand" + schema: + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + 400: + description: "Internal error" + ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/mc-pool/supportable-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.FrequencyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "upper-frequency" + in: "path" + description: "Id of supportable-spectrum" + required: true + type: "integer" + format: "int32" + - name: "lower-frequency" + in: "path" + description: "Id of supportable-spectrum" + required: true + type: "integer" + format: "int32" + responses: + 200: + description: "tapi.photonic.media.FrequencyConstraint" + schema: + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/power-management-capability/: + get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerManagementCapabilityPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.PowerManagementCapabilityPac" + schema: + $ref: "#/definitions/tapi.photonic.media.PowerManagementCapabilityPac" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.PowerManagementCapabilityPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.PowerManagementCapabilityPac.body-param" + description: "tapi.photonic.media.PowerManagementCapabilityPac to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerManagementCapabilityPac" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.PowerManagementCapabilityPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.PowerManagementCapabilityPac.body-param" + description: "tapi.photonic.media.PowerManagementCapabilityPac to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerManagementCapabilityPac" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.PowerManagementCapabilityPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/power-management-capability/supportable-maximum-output-power/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.PowerProperties" + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/power-management-capability/supportable-minimum-output-power/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.PowerProperties" + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/power-management-capability/tolerable-maximum-input-power/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.PowerProperties" + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/service-interface-point={uuid}/media-channel-service-interface-point-spec/power-management-capability/tolerable-minimum-input-power/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.PowerProperties" + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/name/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/service-interface-point={uuid}/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/: + get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.OtsiServiceInterfacePointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.OtsiServiceInterfacePointSpec" + schema: + $ref: "#/definitions/tapi.photonic.media.OtsiServiceInterfacePointSpec" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.OtsiServiceInterfacePointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.OtsiServiceInterfacePointSpec.body-param" + description: "tapi.photonic.media.OtsiServiceInterfacePointSpec to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.OtsiServiceInterfacePointSpec" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.OtsiServiceInterfacePointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.OtsiServiceInterfacePointSpec.body-param" + description: "tapi.photonic.media.OtsiServiceInterfacePointSpec to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.OtsiServiceInterfacePointSpec" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.OtsiServiceInterfacePointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/otsi-capability/: + get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.OtsiCapabilityPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.OtsiCapabilityPac" + schema: + $ref: "#/definitions/tapi.photonic.media.OtsiCapabilityPac" + 400: + description: "Internal error" + ? /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/otsi-capability/supportable-application-identifier={application-code}/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.ApplicationIdentifier" + description: "The list of supportable ApplicationIdentifiers." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "application-code" + in: "path" + description: "Id of supportable-application-identifier" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.ApplicationIdentifier" + schema: + $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifier" + 400: + description: "Internal error" + ? /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/otsi-capability/supportable-central-frequency-band/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.CentralFrequencyBand" + description: "Each spectrum band supported for otsi trasmitter to be tuned on,\ + \ is specified\r\n as per it's lower and upper central frequencies\ + \ supported and its frequency constraints,\r\n consisting in\ + \ the frequency Grid and the AdjustmentGranularity, used to uniquely identify\ + \ all\r\n central frequencies supported within the band." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.CentralFrequencyBand" + schema: + $ref: "#/definitions/tapi.photonic.media.CentralFrequencyBand" + 400: + description: "Internal error" + ? /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/otsi-capability/supportable-central-frequency-band/frequency-constraint/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.FrequencyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.FrequencyConstraint" + schema: + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/otsi-capability/total-power-warn-threshold/: + get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.TotalPowerThresholdPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.TotalPowerThresholdPac" + schema: + $ref: "#/definitions/tapi.photonic.media.TotalPowerThresholdPac" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/power-management-capability/: + get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerManagementCapabilityPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.PowerManagementCapabilityPac" + schema: + $ref: "#/definitions/tapi.photonic.media.PowerManagementCapabilityPac" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.PowerManagementCapabilityPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.PowerManagementCapabilityPac.body-param" + description: "tapi.photonic.media.PowerManagementCapabilityPac to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerManagementCapabilityPac" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.PowerManagementCapabilityPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.PowerManagementCapabilityPac.body-param" + description: "tapi.photonic.media.PowerManagementCapabilityPac to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerManagementCapabilityPac" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.PowerManagementCapabilityPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/power-management-capability/supportable-maximum-output-power/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.PowerProperties" + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/power-management-capability/supportable-minimum-output-power/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.PowerProperties" + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/power-management-capability/tolerable-maximum-input-power/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.PowerProperties" + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.PowerProperties" + description: "This parameter exposes the maximum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/service-interface-point={uuid}/otsi-service-interface-point-spec/power-management-capability/tolerable-minimum-input-power/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.PowerProperties" + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + 400: + description: "Internal error" + post: + tags: + - "tapi-photonic-media" + summary: "creates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-photonic-media" + summary: "creates or updates tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.photonic.media.PowerProperties.body-param" + description: "tapi.photonic.media.PowerProperties to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-photonic-media" + summary: "removes tapi.photonic.media.PowerProperties" + description: "This parameter exposes the minimum input power tolerated\r\n \ + \ at the Logical-Termination-Point (LTP) associated to the SIP." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/total-potential-capacity/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] + responses: + 200: + description: "tapi.topology.TopologyContext" + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-topology" + summary: "creates tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: + - in: "body" + name: "tapi.topology.context.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-topology" + summary: "creates or updates tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: + - in: "body" + name: "tapi.topology.context.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-topology" + summary: "removes tapi.topology.context.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/topology-context/nw-topology-service/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NetworkTopologyService" + description: "none" + parameters: [] + responses: + 200: + description: "tapi.topology.NetworkTopologyService" + schema: + $ref: "#/definitions/tapi.topology.NetworkTopologyService" + 400: + description: "Internal error" + /data/context/topology-context/nw-topology-service/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.TopologyRef" + description: "none" + parameters: + - name: "topology-uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.topologycontext.Topology" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Topology" + schema: + $ref: "#/definitions/tapi.topology.Topology" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/boundary-node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Link" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Link" + schema: + $ref: "#/definitions/tapi.topology.Link" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.ValidationMechanism" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "validation-mechanism" + in: "path" + description: "Id of validation-mechanism" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.ValidationMechanism" + schema: + $ref: "#/definitions/tapi.topology.ValidationMechanism" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.topology.Node" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.topology.Node" + schema: + $ref: "#/definitions/tapi.topology.topology.Node" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.TopologyRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.node.NodeEdgePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.node.NodeEdgePoint" + schema: + $ref: "#/definitions/tapi.topology.node.NodeEdgePoint" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{aggregated-node-edge-point-node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-cep-layer-protocol={layer-protocol-qualifier}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NepLayerProtocolCapability" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "layer-protocol-qualifier" + in: "path" + description: "Id of available-cep-layer-protocol" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NepLayerProtocolCapability" + schema: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/: + get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" + schema: + $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/ + : get: + tags: + - "tapi-connectivity" + summary: "returns tapi.connectivity.ceplist.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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.connectivity.ceplist.ConnectionEndPoint" + schema: + $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/aggregated-connection-end-point={topology-uuid},{aggregated-connection-end-point-node-uuid},{aggregated-connection-end-point-node-edge-point-uuid},{aggregated-connection-end-point-connection-end-point-uuid}/ + : get: + tags: + - "tapi-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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-connection-end-point" + required: true + type: "string" + - name: "aggregated-connection-end-point-node-uuid" + in: "path" + description: "Id of aggregated-connection-end-point" + required: true + type: "string" + - name: "aggregated-connection-end-point-node-edge-point-uuid" + in: "path" + description: "Id of 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.ConnectionEndPointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/client-node-edge-point={topology-uuid},{client-node-edge-point-node-uuid},{client-node-edge-point-node-edge-point-uuid}/ + : get: + tags: + - "tapi-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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of client-node-edge-point" + required: true + type: "string" + - name: "client-node-edge-point-node-uuid" + in: "path" + description: "Id of client-node-edge-point" + required: true + type: "string" + - name: "client-node-edge-point-node-edge-point-uuid" + in: "path" + description: "Id of client-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/media-channel-connection-end-point-spec/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.MediaChannelConnectionEndPointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.MediaChannelConnectionEndPointSpec" + schema: + $ref: "#/definitions/tapi.photonic.media.MediaChannelConnectionEndPointSpec" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/media-channel-connection-end-point-spec/media-channel/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.MediaChannelPropertiesPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.MediaChannelPropertiesPac" + schema: + $ref: "#/definitions/tapi.photonic.media.MediaChannelPropertiesPac" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/media-channel-connection-end-point-spec/media-channel/measured-power-egress/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerProperties" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.PowerProperties" + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/media-channel-connection-end-point-spec/media-channel/measured-power-ingress/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerProperties" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.PowerProperties" + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/media-channel-connection-end-point-spec/media-channel/occupied-spectrum/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.SpectrumBand" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.SpectrumBand" + schema: + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/media-channel-connection-end-point-spec/media-channel/occupied-spectrum/frequency-constraint/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.FrequencyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.FrequencyConstraint" + schema: + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MepMipList" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MepMipList" + schema: + $ref: "#/definitions/tapi.oam.MepMipList" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mep={meg-uuid},{mep-local-id}/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MepRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "meg-uuid" + in: "path" + description: "Id of mep" + required: true + type: "string" + - name: "mep-local-id" + in: "path" + description: "Id of mep" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MepRef" + schema: + $ref: "#/definitions/tapi.oam.MepRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/mep-mip-list/mip={meg-uuid},{mip-local-id}/ + : get: + tags: + - "tapi-oam" + summary: "returns tapi.oam.MipRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "meg-uuid" + in: "path" + description: "Id of mip" + required: true + type: "string" + - name: "mip-local-id" + in: "path" + description: "Id of mip" + required: true + type: "string" + responses: + 200: + description: "tapi.oam.MipRef" + schema: + $ref: "#/definitions/tapi.oam.MipRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/ + : get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduConnectionEndPointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduConnectionEndPointSpec" + schema: + $ref: "#/definitions/tapi.odu.OduConnectionEndPointSpec" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-common/ + : get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduCommonPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduCommonPac" + schema: + $ref: "#/definitions/tapi.odu.OduCommonPac" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-ctp/ + : get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduCtpPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduCtpPac" + schema: + $ref: "#/definitions/tapi.odu.OduCtpPac" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-protection/ + : get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduProtectionPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduProtectionPac" + schema: + $ref: "#/definitions/tapi.odu.OduProtectionPac" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-term-and-adapter/ + : get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduTerminationAndClientAdaptationPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduTerminationAndClientAdaptationPac" + schema: + $ref: "#/definitions/tapi.odu.OduTerminationAndClientAdaptationPac" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/odu-connection-end-point-spec/odu-term-and-adapter/accepted-payload-type/ + : get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduPayloadType" + description: "This attribute is applicable when the ODU CTP object instance\ + \ represents a lower order ODU CTP Sink at the client layer of the ODUP/ODU[i]j\ + \ or ODUP/ODUj-21 adaptation function. \r\n This attribute\ + \ is a 2-digit Hex code that indicates the new accepted payload type.\r\n\ + \ Valid values are defined in Table 15-8 of ITU-T Recommendation\ + \ G.709 with one additional value UN_INTERPRETABLE." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduPayloadType" + schema: + $ref: "#/definitions/tapi.odu.OduPayloadType" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-assembly-connection-end-point-spec/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.OtsiAssemblyConnectionEndPointSpec" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.OtsiAssemblyConnectionEndPointSpec" + schema: + $ref: "#/definitions/tapi.photonic.media.OtsiAssemblyConnectionEndPointSpec" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-assembly-connection-end-point-spec/otsi-adapter/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.OtsiServerAdaptationPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.OtsiServerAdaptationPac" + schema: + $ref: "#/definitions/tapi.photonic.media.OtsiServerAdaptationPac" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-assembly-connection-end-point-spec/otsi-adapter/fec-parameters/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.FecProperties" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.FecProperties" + schema: + $ref: "#/definitions/tapi.photonic.media.FecProperties" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.OtsiConnectionEndPointSpec" + description: "Augments the base LayerProtocol information in ConnectionEndPoint\ + \ with OCH-specific information" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.OtsiConnectionEndPointSpec" + schema: + $ref: "#/definitions/tapi.photonic.media.OtsiConnectionEndPointSpec" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.OtsiTerminationPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.OtsiTerminationPac" + schema: + $ref: "#/definitions/tapi.photonic.media.OtsiTerminationPac" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/laser-properties/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.LaserProperties" + description: "Laser properties." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.LaserProperties" + schema: + $ref: "#/definitions/tapi.photonic.media.LaserProperties" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/received-power/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerProperties" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.PowerProperties" + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/selected-application-identifier/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.ApplicationIdentifier" + description: "This attribute indicates the selected Application Identifier that\ + \ is used by the OCh trail termination function. The syntax of ApplicationIdentifier\ + \ is a pair {ApplicationIdentifierType, PrintableString}. The value of ApplicationIdentifierType\ + \ is either STANDARD or PROPRIETARY. The value of PrintableString represents\ + \ the standard application code as defined in the ITU-T Recommendations or\ + \ a vendor-specific proprietary code. If the ApplicationIdentifierType is\ + \ STANDARD the value of PrintableString represents a standard application\ + \ code as defined in the ITU-T Recommendations. If the ApplicationIdentifierType\ + \ is PROPRIETARY, the first six characters of the PrintableString must contain\ + \ the Hexadecimal representation of an OUI assigned to the vendor whose implementation\ + \ generated the Application Identifier; the remaining octets of the PrintableString\ + \ are unspecified. The value of this attribute of an object instance has to\ + \ be one of the values identified in the attribute SupportableApplicationIdentifierList\ + \ of the same object instance. The values and value ranges of the optical\ + \ interface parameters of a standard application code must be consistent with\ + \ those values specified in the ITU-T Recommendation for that application\ + \ code." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.ApplicationIdentifier" + schema: + $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifier" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/selected-central-frequency/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.CentralFrequency" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.CentralFrequency" + schema: + $ref: "#/definitions/tapi.photonic.media.CentralFrequency" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/selected-central-frequency/frequency-constraint/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.FrequencyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.FrequencyConstraint" + schema: + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/selected-spectrum/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.SpectrumBand" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.SpectrumBand" + schema: + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/selected-spectrum/frequency-constraint/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.FrequencyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.FrequencyConstraint" + schema: + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/otsi-connection-end-point-spec/otsi-termination/transmited-power/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.PowerProperties" + description: "Measured power at the Transmitter." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.PowerProperties" + schema: + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/cep-list/connection-end-point={connection-end-point-uuid}/parent-node-edge-point/ + : get: + tags: + - "tapi-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: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "connection-end-point-uuid" + in: "path" + description: "Id of connection-end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load balancing/Resilience)\ + \ should be considered experimental" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "service-interface-point-uuid" + in: "path" + description: "Id of mapped-service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePointRef" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/media-channel-node-edge-point-spec/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.MediaChannelNodeEdgePointSpec" + description: "Augments the base LayerProtocol information in NodeEdgePoint with\ + \ OCH-specific information" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.MediaChannelNodeEdgePointSpec" + schema: + $ref: "#/definitions/tapi.photonic.media.MediaChannelNodeEdgePointSpec" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/media-channel-node-edge-point-spec/mc-pool/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.MediaChannelPoolCapabilityPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.photonic.media.MediaChannelPoolCapabilityPac" + schema: + $ref: "#/definitions/tapi.photonic.media.MediaChannelPoolCapabilityPac" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/media-channel-node-edge-point-spec/mc-pool/available-spectrum={upper-frequency},{lower-frequency}/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.SpectrumBand" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "upper-frequency" + in: "path" + description: "Id of available-spectrum" + required: true + type: "integer" + format: "int32" + - name: "lower-frequency" + in: "path" + description: "Id of available-spectrum" + required: true + type: "integer" + format: "int32" + responses: + 200: + description: "tapi.photonic.media.SpectrumBand" + schema: + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/media-channel-node-edge-point-spec/mc-pool/available-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.FrequencyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "upper-frequency" + in: "path" + description: "Id of available-spectrum" + required: true + type: "integer" + format: "int32" + - name: "lower-frequency" + in: "path" + description: "Id of available-spectrum" + required: true + type: "integer" + format: "int32" + responses: + 200: + description: "tapi.photonic.media.FrequencyConstraint" + schema: + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/media-channel-node-edge-point-spec/mc-pool/occupied-spectrum={upper-frequency},{lower-frequency}/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.SpectrumBand" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "upper-frequency" + in: "path" + description: "Id of occupied-spectrum" + required: true + type: "integer" + format: "int32" + - name: "lower-frequency" + in: "path" + description: "Id of occupied-spectrum" + required: true + type: "integer" + format: "int32" + responses: + 200: + description: "tapi.photonic.media.SpectrumBand" + schema: + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/media-channel-node-edge-point-spec/mc-pool/occupied-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.FrequencyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "upper-frequency" + in: "path" + description: "Id of occupied-spectrum" + required: true + type: "integer" + format: "int32" + - name: "lower-frequency" + in: "path" + description: "Id of occupied-spectrum" + required: true + type: "integer" + format: "int32" + responses: + 200: + description: "tapi.photonic.media.FrequencyConstraint" + schema: + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/media-channel-node-edge-point-spec/mc-pool/supportable-spectrum={upper-frequency},{lower-frequency}/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.SpectrumBand" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "upper-frequency" + in: "path" + description: "Id of supportable-spectrum" + required: true + type: "integer" + format: "int32" + - name: "lower-frequency" + in: "path" + description: "Id of supportable-spectrum" + required: true + type: "integer" + format: "int32" + responses: + 200: + description: "tapi.photonic.media.SpectrumBand" + schema: + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/media-channel-node-edge-point-spec/mc-pool/supportable-spectrum={upper-frequency},{lower-frequency}/frequency-constraint/ + : get: + tags: + - "tapi-photonic-media" + summary: "returns tapi.photonic.media.FrequencyConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "upper-frequency" + in: "path" + description: "Id of supportable-spectrum" + required: true + type: "integer" + format: "int32" + - name: "lower-frequency" + in: "path" + description: "Id of supportable-spectrum" + required: true + type: "integer" + format: "int32" + responses: + 200: + description: "tapi.photonic.media.FrequencyConstraint" + schema: + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/odu-node-edge-point-spec/ + : get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduNodeEdgePointSpec" + description: "Augments the base LayerProtocol information in NodeEdgePoint with\ + \ ODU-specific information" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduNodeEdgePointSpec" + schema: + $ref: "#/definitions/tapi.odu.OduNodeEdgePointSpec" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/odu-node-edge-point-spec/odu-pool/ + : get: + tags: + - "tapi-odu" + summary: "returns tapi.odu.OduPoolPac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.odu.OduPoolPac" + schema: + $ref: "#/definitions/tapi.odu.OduPoolPac" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroup" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroup" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-rule-group-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroupRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.InterRuleGroup" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.InterRuleGroup" + schema: + $ref: "#/definitions/tapi.topology.InterRuleGroup" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + - name: "associated-node-rule-group-node-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + - name: "associated-node-rule-group-node-rule-group-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroupRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Rule" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Rule" + schema: + $ref: "#/definitions/tapi.topology.Rule" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-node-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Rule" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Rule" + schema: + $ref: "#/definitions/tapi.topology.Rule" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /operations/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/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/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/create-oam-job/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.CreateOamJob" + description: "operates on tapi.oam.CreateOamJob" + parameters: + - in: "body" + name: "tapi.oam.createoamjob.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.createoamjob.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.CreateOamJob" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/create-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.CreateOamProfile" + description: "operates on tapi.oam.CreateOamProfile" + parameters: + - in: "body" + name: "tapi.oam.createoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.createoamprofile.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.CreateOamProfile" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/create-oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.CreateOamServicePoint" + description: "operates on tapi.oam.CreateOamServicePoint" + parameters: + - in: "body" + name: "tapi.oam.createoamservicepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.createoamservicepoint.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.CreateOamServicePoint" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/create-oam-service/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.CreateOamService" + description: "operates on tapi.oam.CreateOamService" + parameters: + - in: "body" + name: "tapi.oam.createoamservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.createoamservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.CreateOamService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/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/delete-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.DeleteNotificationSubscriptionService" + description: "operates on tapi.notification.DeleteNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.deletenotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-oam-job/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamJob" + description: "operates on tapi.oam.DeleteOamJob" + parameters: + - in: "body" + name: "tapi.oam.deleteoamjob.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.deleteoamjob.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamProfile" + description: "operates on tapi.oam.DeleteOamProfile" + parameters: + - in: "body" + name: "tapi.oam.deleteoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.deleteoamprofile.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamServicePoint" + description: "operates on tapi.oam.DeleteOamServicePoint" + parameters: + - in: "body" + name: "tapi.oam.deleteoamservicepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.deleteoamservicepoint.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-oam-service/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.DeleteOamService" + description: "operates on tapi.oam.DeleteOamService" + parameters: + - in: "body" + name: "tapi.oam.deleteoamservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.deleteoamservice.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/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/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/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/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/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/get-link-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetLinkDetails" + description: "operates on tapi.topology.GetLinkDetails" + parameters: + - in: "body" + name: "tapi.topology.getlinkdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getlinkdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetLinkDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-meg/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.GetMeg" + description: "operates on tapi.oam.GetMeg" + parameters: + - in: "body" + name: "tapi.oam.getmeg.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getmeg.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetMeg" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-node-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetNodeDetails" + description: "operates on tapi.topology.GetNodeDetails" + parameters: + - in: "body" + name: "tapi.topology.getnodedetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getnodedetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetNodeDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-node-edge-point-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetNodeEdgePointDetails" + description: "operates on tapi.topology.GetNodeEdgePointDetails" + parameters: + - in: "body" + name: "tapi.topology.getnodeedgepointdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetNodeEdgePointDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-list/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationList" + description: "operates on tapi.notification.GetNotificationList" + parameters: + - in: "body" + name: "tapi.notification.getnotificationlist.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.getnotificationlist.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-subscription-service-details/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + description: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + parameters: + - in: "body" + name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-subscription-service-list/: + post: + tags: + - "tapi-notification" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-job-list/: + post: + tags: + - "tapi-oam" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamJobList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-job/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.GetOamJob" + description: "operates on tapi.oam.GetOamJob" + parameters: + - in: "body" + name: "tapi.oam.getoamjob.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getoamjob.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamJob" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-profile-list/: + post: + tags: + - "tapi-oam" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamProfileList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.GetOamProfile" + description: "operates on tapi.oam.GetOamProfile" + parameters: + - in: "body" + name: "tapi.oam.getoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getoamprofile.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamProfile" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-service-list/: + post: + tags: + - "tapi-oam" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamServiceList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.GetOamServicePoint" + description: "operates on tapi.oam.GetOamServicePoint" + parameters: + - in: "body" + name: "tapi.oam.getoamservicepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getoamservicepoint.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamServicePoint" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-oam-service/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.GetOamService" + description: "operates on tapi.oam.GetOamService" + parameters: + - in: "body" + name: "tapi.oam.getoamservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.getoamservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.GetOamService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-service-interface-point-details/: + post: + tags: + - "tapi-common" + summary: "operates on tapi.common.GetServiceInterfacePointDetails" + description: "operates on tapi.common.GetServiceInterfacePointDetails" + parameters: + - in: "body" + name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.common.GetServiceInterfacePointDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-service-interface-point-list/: + post: + tags: + - "tapi-common" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.common.GetServiceInterfacePointList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-supported-notification-types/: + post: + tags: + - "tapi-notification" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetSupportedNotificationTypes" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-topology-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetTopologyDetails" + description: "operates on tapi.topology.GetTopologyDetails" + parameters: + - in: "body" + name: "tapi.topology.gettopologydetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.gettopologydetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetTopologyDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-topology-list/: + post: + tags: + - "tapi-topology" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetTopologyList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/optimize-p-2-p-path/: + 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/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/update-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.UpdateNotificationSubscriptionService" + description: "operates on tapi.notification.UpdateNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.UpdateNotificationSubscriptionService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-oam-job/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamJob" + description: "operates on tapi.oam.UpdateOamJob" + parameters: + - in: "body" + name: "tapi.oam.updateoamjob.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.updateoamjob.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.UpdateOamJob" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-oam-profile/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamProfile" + description: "operates on tapi.oam.UpdateOamProfile" + parameters: + - in: "body" + name: "tapi.oam.updateoamprofile.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.updateoamprofile.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.UpdateOamProfile" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-oam-service-point/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamServicePoint" + description: "operates on tapi.oam.UpdateOamServicePoint" + parameters: + - in: "body" + name: "tapi.oam.updateoamservicepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.updateoamservicepoint.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.UpdateOamServicePoint" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-oam-service/: + post: + tags: + - "tapi-oam" + summary: "operates on tapi.oam.UpdateOamService" + description: "operates on tapi.oam.UpdateOamService" + parameters: + - in: "body" + name: "tapi.oam.updateoamservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.oam.updateoamservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.oam.UpdateOamService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-service-interface-point/: + post: + tags: + - "tapi-common" + summary: "operates on tapi.common.UpdateServiceInterfacePoint" + description: "operates on tapi.common.UpdateServiceInterfacePoint" + parameters: + - in: "body" + name: "tapi.common.updateserviceinterfacepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.common.updateserviceinterfacepoint.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" +definitions: + tapi.common.AdminStatePac: + type: "object" + properties: + operational-state: + description: "none" + $ref: "#/definitions/tapi.common.OperationalState" + lifecycle-state: + description: "none" + $ref: "#/definitions/tapi.common.LifecycleState" + administrative-state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + tapi.common.AdministrativeState: + type: "string" + enum: + - "LOCKED" + - "UNLOCKED" + tapi.common.Capacity: + type: "object" + properties: + total-size: + description: "Total capacity of the TopologicalEntity in MB/s. In case of\ + \ bandwidthProfile, this is expected to same as the committedInformationRate." + $ref: "#/definitions/tapi.common.CapacityValue" + tapi.common.CapacityPac: + type: "object" + properties: + available-capacity: + description: "Capacity available to be assigned." + $ref: "#/definitions/tapi.common.Capacity" + total-potential-capacity: + description: "An optimistic view of the capacity of the TopologicalEntity\ + \ assuming that any shared capacity is available to be taken." + $ref: "#/definitions/tapi.common.Capacity" + tapi.common.CapacityUnit: + type: "string" + enum: + - "TB" + - "TBPS" + - "GB" + - "GBPS" + - "MB" + - "MBPS" + - "KB" + - "KBPS" + - "GHz" + - "MHz" + tapi.common.CapacityValue: + type: "object" + properties: + value: + type: "integer" + format: "int32" + description: "none" + unit: + description: "none" + $ref: "#/definitions/tapi.common.CapacityUnit" + tapi.common.Context: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.connectivity.ContextAugmentation4" + - $ref: "#/definitions/tapi.notification.ContextAugmentation1" + - $ref: "#/definitions/tapi.oam.ContextAugmentation3" + - $ref: "#/definitions/tapi.path.computation.ContextAugmentation2" + - $ref: "#/definitions/tapi.topology.ContextAugmentation5" + - type: "object" + properties: + service-interface-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.context.ServiceInterfacePoint" + description: "none" + tapi.common.DirectiveValue: + type: "string" + enum: + - "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. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a UUID\ + \ in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.common.LayerProtocolName: + type: "string" + enum: + - "ODU" + - "ETH" + - "DSR" + - "PHOTONIC_MEDIA" + tapi.common.LifecycleState: + type: "string" + enum: + - "PLANNED" + - "POTENTIAL_AVAILABLE" + - "POTENTIAL_BUSY" + - "INSTALLED" + - "PENDING_REMOVAL" + tapi.common.LocalClass: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + local-id: + type: "string" + description: "none" + tapi.common.NameAndValue: + type: "object" + properties: + value-name: + type: "string" + description: "The name of the value. The value need not have a name." + value: + type: "string" + description: "The value" + tapi.common.OperationalState: + type: "string" + enum: + - "DISABLED" + - "ENABLED" + tapi.common.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" + 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.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.TimeInterval: + type: "object" + properties: + period: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.TimePeriod" + tapi.common.TimePeriod: + type: "object" + properties: + value: + type: "integer" + format: "int32" + description: "none" + unit: + description: "none" + $ref: "#/definitions/tapi.common.TimeUnit" + tapi.common.TimeRange: + type: "object" + properties: + end-time: + type: "string" + description: "none" + start-time: + type: "string" + description: "none" + tapi.common.TimeUnit: + type: "string" + enum: + - "YEARS" + - "MONTHS" + - "DAYS" + - "HOURS" + - "MINUTES" + - "SECONDS" + - "MILLISECONDS" + - "MICROSECONDS" + - "NANOSECONDS" + - "PICOSECONDS" + tapi.common.context.ServiceInterfacePoint: + allOf: + - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + - $ref: "#/definitions/tapi.photonic.media.ServiceInterfacePointAugmentation1" + - $ref: "#/definitions/tapi.photonic.media.ServiceInterfacePointAugmentation2" + tapi.common.getserviceinterfacepointdetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.common.getserviceinterfacepointdetails.Output: + type: "object" + properties: + sip: + description: "none" + $ref: "#/definitions/tapi.common.getserviceinterfacepointlist.output.Sip" + tapi.common.getserviceinterfacepointlist.Output: + type: "object" + properties: + sip: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.getserviceinterfacepointlist.output.Sip" + tapi.common.getserviceinterfacepointlist.output.Sip: + allOf: + - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + - $ref: "#/definitions/tapi.photonic.media.SipAugmentation1" + - $ref: "#/definitions/tapi.photonic.media.SipAugmentation2" + tapi.common.updateserviceinterfacepoint.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + tapi.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" + bounding-node: + description: "none" + $ref: "#/definitions/tapi.topology.NodeRef" + 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: + protection-role: + description: "none" + $ref: "#/definitions/tapi.connectivity.ProtectionRole" + 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" + 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:node-edge-point/tapi-connectivity:cep-list/tapi-connectivity:connection-end-point/tapi-connectivity:uuid" + description: "none" + 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.ConnectivityConstraint: + type: "object" + properties: + schedule: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + requested-capacity: + description: "none" + $ref: "#/definitions/tapi.common.Capacity" + diversity-exclusion: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + 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\r\n Class of Service Name." + service-type: + description: "none" + $ref: "#/definitions/tapi.connectivity.ServiceType" + coroute-inclusion: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + tapi.connectivity.ConnectivityContext: + type: "object" + properties: + connectivity-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectivityService" + connection: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.Connection" + tapi.connectivity.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" + direction: + description: "The orientation of defined flow at the EndPoint." + $ref: "#/definitions/tapi.common.PortDirection" + capacity: + description: "none" + $ref: "#/definitions/tapi.common.Capacity" + protecting-connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + description: "The association of the FC to LTPs is made via EndPoints.\r\n \ + \ The EndPoint (EP) object class models the access to the FC function.\ + \ \r\n The traffic forwarding between the associated EPs of the\ + \ FC depends upon the type of FC and may be associated with FcSwitch object\ + \ instances. \r\n In cases where there is resilience the EndPoint\ + \ may convey the resilience role of the access to the FC. \r\n \ + \ It can represent a protected (resilient/reliable) point or a protecting\ + \ (unreliable working or protection) point.\r\n The EP replaces\ + \ the Protection Unit of a traditional protection model. \r\n The\ + \ ForwadingConstruct can be considered as a component and the EndPoint as\ + \ a Port on that component" + tapi.connectivity.ConnectivityServiceEndPointRef: + allOf: + - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" + - type: "object" + properties: + connectivity-service-end-point-local-id: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-connectivity:connectivity-context/tapi-connectivity:connectivity-service/tapi-connectivity:end-point/tapi-connectivity:local-id" + description: "none" + tapi.connectivity.ConnectivityServiceRef: + type: "object" + properties: + 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.ContextAugmentation4: + 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.NodeEdgePointAugmentation1: + type: "object" + properties: + cep-list: + description: "none" + $ref: "#/definitions/tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.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." + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" + hold-off-time: + type: "integer" + format: "int32" + description: "This attribute indicates the time, in milliseconds, between\ + \ declaration of signal degrade or signal fail, and the initialization of\ + \ the protection switching algorithm." + 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 + selection-control: + description: "Degree of administrative control applied to the switch selection." + $ref: "#/definitions/tapi.connectivity.SelectionControl" + preferred-restoration-layer: + type: "array" + description: "Indicate which layer this resilience parameters package configured\ + \ for." + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + restore-priority: + type: "integer" + format: "int32" + description: "none" + restoration-policy: + description: "none" + $ref: "#/definitions/tapi.topology.RestorationPolicy" + restoration-coordinate-type: + description: " The coordination mechanism between multi-layers." + $ref: "#/definitions/tapi.connectivity.CoordinateType" + is-coordinated-switching-both-ends: + type: "boolean" + description: "Is operating such that switching at both ends of each flow acorss\ + \ the FC is coordinated at both ingress and egress ends." + default: false + fault-condition-determination: + type: "string" + description: "none" + is-frozen: + type: "boolean" + description: "Temporarily prevents any switch action to be taken and, as such,\ + \ freezes the current state. \r\n Until the freeze is cleared,\ + \ additional near-end external commands are rejected and fault condition\ + \ changes and received APS messages are ignored.\r\n All\ + \ administrative controls of any aspect of protection are rejected." + default: false + reversion-mode: + description: "Indcates whether the protection scheme is revertive or non-revertive." + $ref: "#/definitions/tapi.connectivity.ReversionMode" + 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" + description: "The FC Route (FcRoute) object class models the individual routes\ + \ of an FC. \r\n The route of an FC object is represented by a\ + \ list of FCs at a lower level. \r\n Note that depending on the\ + \ service supported by an FC, an the FC can have multiple routes." + 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.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-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.UpdateConnectivityService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.connectivity.updateconnectivityservice.Output" + tapi.connectivity.ceplist.ConnectionEndPoint: + allOf: + - $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" + - $ref: "#/definitions/tapi.oam.ConnectionEndPointAugmentation4" + - $ref: "#/definitions/tapi.odu.ConnectionEndPointAugmentation5" + - $ref: "#/definitions/tapi.photonic.media.ConnectionEndPointAugmentation1" + - $ref: "#/definitions/tapi.photonic.media.ConnectionEndPointAugmentation2" + - $ref: "#/definitions/tapi.photonic.media.ConnectionEndPointAugmentation3" + tapi.connectivity.connectivitycontext.ConnectivityService: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + connection: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "none" + tapi.connectivity.connectivityservice.EndPoint: + allOf: + - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + - $ref: "#/definitions/tapi.odu.EndPointAugmentation3" + - $ref: "#/definitions/tapi.photonic.media.EndPointAugmentation1" + - $ref: "#/definitions/tapi.photonic.media.EndPointAugmentation2" + tapi.connectivity.context.topologycontext.topology.node.nodeedgepoint.CepList: + allOf: + - type: "object" + properties: + connection-end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ceplist.ConnectionEndPoint" + description: "none" + tapi.connectivity.createconnectivityservice.Input: + type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.createconnectivityservice.input.EndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.createconnectivityservice.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.connectivity.createconnectivityservice.output.Service" + tapi.connectivity.createconnectivityservice.input.EndPoint: + allOf: + - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" + - $ref: "#/definitions/tapi.photonic.media.EndPointAugmentation1" + - $ref: "#/definitions/tapi.photonic.media.EndPointAugmentation2" + tapi.connectivity.createconnectivityservice.output.Service: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.createconnectivityservice.input.EndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + connection: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "none" + tapi.connectivity.deleteconnectivityservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.getconnectiondetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.getconnectiondetails.Output: + type: "object" + properties: + connection: + description: "none" + $ref: "#/definitions/tapi.connectivity.Connection" + tapi.connectivity.getconnectionendpointdetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.getconnectionendpointdetails.Output: + type: "object" + properties: + connection-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.getconnectionendpointdetails.output.ConnectionEndPoint" + tapi.connectivity.getconnectionendpointdetails.output.ConnectionEndPoint: + allOf: + - $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" + - $ref: "#/definitions/tapi.photonic.media.ConnectionEndPointAugmentation1" + - $ref: "#/definitions/tapi.photonic.media.ConnectionEndPointAugmentation2" + - $ref: "#/definitions/tapi.photonic.media.ConnectionEndPointAugmentation3" + tapi.connectivity.getconnectivityservicedetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.getconnectivityservicedetails.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.connectivity.getconnectivityservicedetails.output.Service" + tapi.connectivity.getconnectivityservicedetails.output.Service: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.createconnectivityservice.input.EndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + connection: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "none" + tapi.connectivity.getconnectivityservicelist.Output: + type: "object" + properties: + service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.getconnectivityservicelist.output.Service" + tapi.connectivity.getconnectivityservicelist.output.Service: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.createconnectivityservice.input.EndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + connection: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "none" + tapi.connectivity.updateconnectivityservice.Input: + type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.createconnectivityservice.input.EndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.connectivity.updateconnectivityservice.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.connectivity.updateconnectivityservice.output.Service" + tapi.connectivity.updateconnectivityservice.output.Service: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.createconnectivityservice.input.EndPoint" + resilience-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + connection: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.connectivity.ConnectionRef" + connectivity-constraint: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "none" + tapi.notification.ContextAugmentation1: + type: "object" + properties: + notification-context: + description: "Augments the base TAPI Context with NotificationService information" + $ref: "#/definitions/tapi.notification.context.NotificationContext" + x-augmentation: + prefix: "tapi-notification" + namespace: "urn:onf:otcc:yang:tapi-notification" + tapi.notification.CreateNotificationSubscriptionService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Output" + tapi.notification.GetNotificationList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationlist.Output" + tapi.notification.GetNotificationSubscriptionServiceDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Output" + tapi.notification.GetNotificationSubscriptionServiceList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicelist.Output" + tapi.notification.GetSupportedNotificationTypes: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getsupportednotificationtypes.Output" + tapi.notification.NameAndValueChange: + type: "object" + properties: + value-name: + type: "string" + description: "The name of the value. The value need not have a name." + old-value: + type: "string" + description: "The value" + new-value: + type: "string" + description: "The value" + tapi.notification.Notification: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + target-object-type: + type: "string" + description: "none" + additional-text: + type: "string" + description: "none" + event-time-stamp: + type: "string" + description: "none" + additional-info: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.NameAndValue" + sequence-number: + type: "integer" + format: "int32" + description: "A monotonous increasing sequence number associated with the\ + \ notification.\r\n The exact semantics of how this sequence\ + \ number is assigned (per channel or subscription or source or system)\ + \ is left undefined." + target-object-identifier: + type: "string" + description: "none" + notification-type: + type: "string" + description: "none" + target-object-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.NameAndValue" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + source-indicator: + description: "none" + $ref: "#/definitions/tapi.notification.SourceIndicator" + layer-protocol-qualifier: + type: "string" + description: "none" + changed-attributes: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + description: "none" + tapi.notification.NotificationChannel: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + next-sequence-no: + type: "integer" + format: "int32" + description: "The sequence number of the next notification that will be\ + \ published on the channel" + stream-address: + type: "string" + description: "The address/location/URI of the channel/stream to which the\ + \ subscribed notifications are published.\r\n This specifics\ + \ of this is typically dependent on the implementation protocol & mechanism\ + \ and hence is typed as a string." + description: "none" + tapi.notification.NotificationSubscriptionService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.Notification" + notification-channel: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationChannel" + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + supported-object-types: + type: "array" + description: "none" + items: + type: "string" + supported-notification-types: + type: "array" + description: "none" + items: + type: "string" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + description: "none" + tapi.notification.SourceIndicator: + type: "string" + enum: + - "RESOURCE_OPERATION" + - "MANAGEMENT_OPERATION" + - "UNKNOWN" + tapi.notification.SubscriptionFilter: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + requested-notification-types: + type: "array" + description: "none" + items: + type: "string" + requested-object-identifier: + type: "array" + description: "none" + items: + type: "string" + requested-layer-protocols: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + include-content: + type: "boolean" + description: "Indicates whether the published Notification includes content\ + \ or just the Notification Id (which enables retrieval of the notification\ + \ at the later stage)" + default: false + requested-object-types: + type: "array" + description: "none" + items: + type: "string" + description: "none" + tapi.notification.SubscriptionState: + type: "string" + enum: + - "SUSPENDED" + - "ACTIVE" + tapi.notification.UpdateNotificationSubscriptionService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Output" + tapi.notification.context.NotificationContext: + allOf: + - type: "object" + properties: + notif-subscription: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" + description: "Augments the base TAPI Context with NotificationService information" + tapi.notification.createnotificationsubscriptionservice.Input: + type: "object" + properties: + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + tapi.notification.createnotificationsubscriptionservice.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.deletenotificationsubscriptionservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationlist.Input: + type: "object" + properties: + time-range: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + subscription-id: + type: "string" + description: "UUID of the associated Notification Subscription Service: An\ + \ identifier that is universally unique within an identifier space, where\ + \ the identifier space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationlist.Output: + type: "object" + properties: + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.notificationcontext.Notification" + tapi.notification.getnotificationsubscriptionservicedetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationsubscriptionservicedetails.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.getnotificationsubscriptionservicelist.Output: + type: "object" + properties: + subscription-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.getsupportednotificationtypes.Output: + type: "object" + properties: + supported-object-types: + type: "array" + description: "none" + items: + type: "string" + supported-notification-types: + type: "array" + description: "none" + items: + type: "string" + tapi.notification.notificationcontext.Notification: + allOf: + - $ref: "#/definitions/tapi.notification.Notification" + - $ref: "#/definitions/tapi.oam.NotificationAugmentation1" + - $ref: "#/definitions/tapi.oam.NotificationAugmentation2" + tapi.notification.updatenotificationsubscriptionservice.Input: + type: "object" + properties: + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + tapi.notification.updatenotificationsubscriptionservice.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.oam.AlarmInfo: + type: "object" + properties: + perceived-severity: + description: "none" + $ref: "#/definitions/tapi.oam.PerceivedSeverityType" + probable-cause: + type: "string" + description: "none" + service-affecting: + description: "none" + $ref: "#/definitions/tapi.oam.ServiceAffecting" + is-transient: + type: "boolean" + description: "none" + default: false + tapi.oam.ConnectionEndPointAugmentation4: + type: "object" + properties: + mep-mip-list: + description: "none" + $ref: "#/definitions/tapi.oam.MepMipList" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" + tapi.oam.ContextAugmentation3: + type: "object" + properties: + oam-context: + description: "Augments the base TAPI Context with OamService information" + $ref: "#/definitions/tapi.oam.context.OamContext" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" + tapi.oam.CreateOamJob: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.createoamjob.Output" + tapi.oam.CreateOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.createoamprofile.Output" + tapi.oam.CreateOamService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.createoamservice.Output" + tapi.oam.CreateOamServicePoint: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.createoamservicepoint.Output" + tapi.oam.CurrentData: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + elapsed-time: + description: "none" + $ref: "#/definitions/tapi.common.TimeInterval" + period-start-time: + type: "string" + description: "This attribute indicates the start of the current monitoring\ + \ interval.\r\n The value is bound to the quarter of an\ + \ hour in case of a 15 minute interval and bound to the hour in case of\ + \ a 24 hour interval." + pm-data-pac: + description: "none" + $ref: "#/definitions/tapi.oam.PmDataPac" + history-data: + type: "array" + description: "in case of 24hr Current Data, at least 1 History Data.\r\n\ + \ In case of 15min Current Data, at least 16 History Data.\r\ + \n In case of <15min, the number of History Data shall\ + \ be able to cover a span of 4 hours." + items: + $ref: "#/definitions/tapi.oam.HistoryData" + description: "none" + tapi.oam.GetMeg: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getmeg.Output" + tapi.oam.GetOamJob: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamjob.Output" + tapi.oam.GetOamJobList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamjoblist.Output" + tapi.oam.GetOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamprofile.Output" + tapi.oam.GetOamProfileList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamprofilelist.Output" + tapi.oam.GetOamService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamservice.Output" + tapi.oam.GetOamServiceList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamservicelist.Output" + tapi.oam.GetOamServicePoint: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.getoamservicepoint.Output" + tapi.oam.HistoryData: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + period-start-time: + type: "string" + description: "This attribute indicates the start of the monitoring interval.\r\ + \n The value is bound to the quarter of an hour in case\ + \ of a 15 minute interval and bound to the hour in case of a 24 hour interval." + pm-data-pac: + description: "none" + $ref: "#/definitions/tapi.oam.PmDataPac" + period-end-time: + type: "string" + description: "none" + description: "none" + tapi.oam.Meg: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.common.OperationalStatePac" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + mep: + type: "array" + description: "1. ME may have 0 MEPs (case of transit domains where at least\ + \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case of edge\ + \ domaind, where the peer MEP is ouside the managed domain)\r\n \ + \ 3. ME may have 2 MEPs" + items: + $ref: "#/definitions/tapi.oam.Mep" + mip: + type: "array" + description: "ME may 0, 1, or more MIPs" + items: + $ref: "#/definitions/tapi.oam.Mip" + description: "none" + tapi.oam.MegRef: + type: "object" + properties: + meg-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:uuid" + tapi.oam.Mep: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - $ref: "#/definitions/tapi.common.OperationalStatePac" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + description: "none" + tapi.oam.MepMipList: + type: "object" + properties: + mip: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.MipRef" + mep: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.MepRef" + tapi.oam.MepRef: + allOf: + - $ref: "#/definitions/tapi.oam.MegRef" + - type: "object" + properties: + mep-local-id: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:mep/tapi-oam:local-id" + description: "none" + tapi.oam.Mip: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + description: "none" + tapi.oam.MipRef: + allOf: + - $ref: "#/definitions/tapi.oam.MegRef" + - type: "object" + properties: + mip-local-id: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:mip/tapi-oam:local-id" + description: "none" + tapi.oam.NotificationAugmentation1: + type: "object" + properties: + tca-info: + description: "none" + $ref: "#/definitions/tapi.oam.TcaInfo" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" + tapi.oam.NotificationAugmentation2: + type: "object" + properties: + alarm-info: + description: "none" + $ref: "#/definitions/tapi.oam.AlarmInfo" + x-augmentation: + prefix: "tapi-oam" + namespace: "urn:onf:otcc:yang:tapi-oam" + tapi.oam.OamJob: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + schedule: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + oam-profile: + description: "none" + $ref: "#/definitions/tapi.oam.OamProfileRef" + creation-time: + type: "string" + description: "none" + oam-job-type: + type: "string" + description: "none" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamServicePointRef" + current-data: + type: "array" + description: "Granularity period of the CurrentData identifies the specific\ + \ CurrentData instance in the scope of this OamJob.\r\n \ + \ For example, typically at least\r\n one 15min and\r\n\ + \ one 24hr;\r\n optionally one additional\ + \ configurable (< 15min)" + items: + $ref: "#/definitions/tapi.oam.CurrentData" + description: "none" + tapi.oam.OamJobRef: + type: "object" + properties: + oam-job-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-job/tapi-oam:uuid" + tapi.oam.OamProfile: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + pm-threshold-data: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.PmThresholdData" + description: "none" + tapi.oam.OamProfileRef: + type: "object" + properties: + oam-profile-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-profile/tapi-oam:uuid" + tapi.oam.OamService: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamServicePoint" + meg: + description: "none" + $ref: "#/definitions/tapi.oam.MegRef" + description: "none" + tapi.oam.OamServicePoint: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + connectivity-service-end-point: + description: "none" + $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPointRef" + mip: + description: "none" + $ref: "#/definitions/tapi.oam.MipRef" + service-interface-point: + description: "none" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + is-mip: + type: "boolean" + description: "If true, the object is related to a MIP.\r\n \ + \ If false, the object is related to a MEP." + default: false + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + mep: + description: "none" + $ref: "#/definitions/tapi.oam.MepRef" + description: "none" + tapi.oam.OamServicePointRef: + allOf: + - $ref: "#/definitions/tapi.oam.OamServiceRef" + - type: "object" + properties: + oam-service-point-local-id: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:oam-service-point/tapi-oam:local-id" + description: "none" + tapi.oam.OamServiceRef: + type: "object" + properties: + oam-service-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:uuid" + tapi.oam.PerceivedSeverityType: + type: "string" + enum: + - "CRITICAL" + - "MAJOR" + - "MINOR" + - "WARNING" + - "CLEARED" + tapi.oam.PerceivedTcaSeverity: + type: "string" + enum: + - "WARNING" + - "CLEAR" + tapi.oam.PmDataPac: + type: "object" + properties: + suspect-interval-flag: + type: "boolean" + description: "This attribute is used to indicate that the performance data\ + \ for the current period may not be reliable. Some reasons for this to occur\ + \ are:\r\n – Suspect data were detected by the actual resource\ + \ doing data collection.\r\n – Transition of the administrativeState\ + \ attribute to/from the 'lock' state.\r\n – Transition of\ + \ the operationalState to/from the 'disabled' state.\r\n \ + \ – Scheduler setting that inhibits the collection function.\r\n \ + \ – The performance counters were reset during the interval.\r\n\ + \ – The currentData (or subclass) object instance was created\ + \ during the monitoring period." + default: false + granularity-period: + description: "none" + $ref: "#/definitions/tapi.common.TimePeriod" + tapi.oam.PmParameterValue: + type: "object" + properties: + pm-parameter-int-value: + type: "integer" + format: "int32" + description: "none" + pm-parameter-real-value: + type: "string" + description: "none" + tapi.oam.PmThresholdData: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + granularity-period: + description: "none" + $ref: "#/definitions/tapi.common.TimePeriod" + threshold-parameter: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.ThresholdParameter" + is-transient: + type: "boolean" + description: "none" + default: false + applicable-job-type: + type: "array" + description: "This attribute allows an PMThresholdData instance to be constrained\ + \ to specific job types. If an PMThresholdData instance is so configured\ + \ to be applicable to more than one job type (worst case ALL), only the\ + \ parameters relevant for the job instance will be used (non-applicable\ + \ profile parameters will be ignored)" + items: + type: "string" + description: "none" + tapi.oam.ServiceAffecting: + type: "string" + enum: + - "SERVICE_AFFECTING" + - "NOT_SERVICE_AFFECTING" + - "UNKNOWN" + tapi.oam.TcaInfo: + type: "object" + properties: + oam-job: + description: "MEF 35.1\r\n Identification of the PM Session\ + \ for which the TCA Function was configured." + $ref: "#/definitions/tapi.oam.OamJobRef" + threshold-parameter: + description: "none" + $ref: "#/definitions/tapi.oam.ThresholdParameter" + is-transient: + type: "boolean" + description: "none" + default: false + perceived-severity: + description: "none" + $ref: "#/definitions/tapi.oam.PerceivedTcaSeverity" + suspect-interval-flag: + type: "boolean" + description: "none" + default: false + measurement-interval: + type: "string" + description: "none" + tapi.oam.ThresholdCrossingQualifier: + type: "string" + enum: + - "NOT_APPLICABLE" + - "NEAR_END" + - "FAR_END" + - "BIDIRECTIONAL" + - "FORWARD" + - "BACKWARD" + tapi.oam.ThresholdParameter: + type: "object" + properties: + pm-parameter-below-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-clear-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-above-thrs: + description: "none" + $ref: "#/definitions/tapi.oam.PmParameterValue" + pm-parameter-name: + type: "string" + description: "none" + threshold-location: + description: "none" + $ref: "#/definitions/tapi.oam.ThresholdCrossingQualifier" + tapi.oam.UpdateOamJob: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.updateoamjob.Output" + tapi.oam.UpdateOamProfile: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.updateoamprofile.Output" + tapi.oam.UpdateOamService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.updateoamservice.Output" + tapi.oam.UpdateOamServicePoint: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.oam.updateoamservicepoint.Output" + tapi.oam.context.OamContext: + allOf: + - type: "object" + properties: + oam-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamService" + oam-profile: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamProfile" + oam-job: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamJob" + meg: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.oamcontext.Meg" + description: "Augments the base TAPI Context with OamService information" + tapi.oam.createoamjob.Input: + type: "object" + properties: + schedule: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point-id: + type: "string" + description: "UUID of the associated OSEPs: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + oam-job-type: + type: "string" + description: "none" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + oam-profile-id: + type: "string" + description: "UUID of the OamProfile to be applied: An identifier that is\ + \ universally unique within an identifier space, where the identifier space\ + \ is itself globally unique, and immutable.\r\n An UUID\ + \ carries no semantics with respect to the purpose or state of the entity.\r\ + \n UUID here uses string representation as defined in\ + \ RFC 4122. The canonical representation uses lowercase characters.\r\n\ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + oam-service-id: + type: "string" + description: "UUID of the associated OamService: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.createoamjob.Output: + type: "object" + properties: + oam-job: + description: "none" + $ref: "#/definitions/tapi.oam.OamJob" + tapi.oam.createoamprofile.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + pm-threshold-data: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.PmThresholdData" + tapi.oam.createoamprofile.Output: + type: "object" + properties: + oam-profile: + description: "none" + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.createoamservice.Input: + type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamServicePoint" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.createoamservice.Output: + type: "object" + properties: + oam-service: + description: "none" + $ref: "#/definitions/tapi.oam.OamService" + tapi.oam.createoamservicepoint.Input: + type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + connectivity-service-end-point-id: + type: "string" + description: "UUID of the CSEP to be monitored: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + service-interface-point-id: + type: "string" + description: "UUID of the associated SIP to be monitored: An identifier that\ + \ is universally unique within an identifier space, where the identifier\ + \ space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose or state of\ + \ the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + oam-service-id: + type: "string" + description: "UUID of the parent OamService: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.createoamservicepoint.Output: + type: "object" + properties: + oam-service-point: + description: "none" + $ref: "#/definitions/tapi.oam.OamServicePoint" + tapi.oam.deleteoamjob.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamprofile.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.deleteoamservicepoint.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getmeg.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getmeg.Output: + type: "object" + properties: + meg: + description: "none" + $ref: "#/definitions/tapi.oam.Meg" + tapi.oam.getoamjob.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamjob.Output: + type: "object" + properties: + oam-job: + description: "none" + $ref: "#/definitions/tapi.oam.OamJob" + tapi.oam.getoamjoblist.Output: + type: "object" + properties: + oam-job: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamJob" + tapi.oam.getoamprofile.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamprofile.Output: + type: "object" + properties: + oam-profile: + description: "none" + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.getoamprofilelist.Output: + type: "object" + properties: + oam-profile: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.getoamservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamservice.Output: + type: "object" + properties: + oam-service: + description: "none" + $ref: "#/definitions/tapi.oam.OamService" + tapi.oam.getoamservicelist.Output: + type: "object" + properties: + oam-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamService" + tapi.oam.getoamservicepoint.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.getoamservicepoint.Output: + type: "object" + properties: + oam-service-point: + description: "none" + $ref: "#/definitions/tapi.oam.OamServicePoint" + tapi.oam.meg.Mep: + allOf: + - $ref: "#/definitions/tapi.oam.Mep" + - $ref: "#/definitions/tapi.odu.MepAugmentation1" + tapi.oam.meg.Mip: + allOf: + - $ref: "#/definitions/tapi.oam.Mip" + - $ref: "#/definitions/tapi.odu.MipAugmentation1" + tapi.oam.oamcontext.Meg: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.common.OperationalStatePac" + - $ref: "#/definitions/tapi.odu.MegAugmentation1" + - type: "object" + properties: + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + mep: + type: "array" + description: "1. ME may have 0 MEPs (case of transit domains where at least\ + \ 1 MIP is present)\r\n 2. ME may have 1 MEP (case of edge\ + \ domaind, where the peer MEP is ouside the managed domain)\r\n \ + \ 3. ME may have 2 MEPs" + items: + $ref: "#/definitions/tapi.oam.meg.Mep" + mip: + type: "array" + description: "ME may 0, 1, or more MIPs" + items: + $ref: "#/definitions/tapi.oam.meg.Mip" + description: "none" + tapi.oam.updateoamjob.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + schedule: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + oam-profile-id: + type: "string" + description: "UUID of the OamProfile to be applied: An identifier that is\ + \ universally unique within an identifier space, where the identifier space\ + \ is itself globally unique, and immutable.\r\n An UUID\ + \ carries no semantics with respect to the purpose or state of the entity.\r\ + \n UUID here uses string representation as defined in\ + \ RFC 4122. The canonical representation uses lowercase characters.\r\n\ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.updateoamjob.Output: + type: "object" + properties: + oam-job: + description: "none" + $ref: "#/definitions/tapi.oam.OamJob" + tapi.oam.updateoamprofile.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + pm-threshold-data: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.PmThresholdData" + tapi.oam.updateoamprofile.Output: + type: "object" + properties: + oam-profile: + description: "none" + $ref: "#/definitions/tapi.oam.OamProfile" + tapi.oam.updateoamservice.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + oam-service-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.oam.OamServicePoint" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.updateoamservice.Output: + type: "object" + properties: + oam-service: + description: "none" + $ref: "#/definitions/tapi.oam.OamService" + tapi.oam.updateoamservicepoint.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.oam.updateoamservicepoint.Output: + type: "object" + properties: + oam-service-point: + description: "none" + $ref: "#/definitions/tapi.oam.OamServicePoint" + tapi.odu.ConnectionEndPointAugmentation5: + type: "object" + properties: + odu-connection-end-point-spec: + description: "none" + $ref: "#/definitions/tapi.odu.OduConnectionEndPointSpec" + x-augmentation: + prefix: "tapi-odu" + namespace: "urn:onf:otcc:yang:tapi-odu" + tapi.odu.DegThr: + type: "object" + properties: + deg-thr-value: + type: "integer" + format: "int32" + description: "Percentage of detected errored blocks" + percentage-granularity: + description: "none" + $ref: "#/definitions/tapi.odu.PercentageGranularity" + deg-thr-type: + description: "Number of errored blocks" + $ref: "#/definitions/tapi.odu.DegThrType" + tapi.odu.DegThrType: + type: "string" + enum: + - "PERCENTAGE" + - "NUMBER_ERRORED_BLOCKS" + tapi.odu.EndPointAugmentation3: + type: "object" + properties: + odu-connectivity-service-end-point-spec: + description: "none" + $ref: "#/definitions/tapi.odu.OduConnectivityServiceEndPointSpec" + x-augmentation: + prefix: "tapi-odu" + namespace: "urn:onf:otcc:yang:tapi-odu" + tapi.odu.MappingType: + type: "string" + enum: + - "AMP" + - "BMP" + - "GFP-F" + - "GMP" + - "TTP_GFP_BMP" + - "NULL" + tapi.odu.MegAugmentation1: + type: "object" + properties: + odu-meg-spec: + description: "none" + $ref: "#/definitions/tapi.odu.OduMegSpec" + x-augmentation: + prefix: "tapi-odu" + namespace: "urn:onf:otcc:yang:tapi-odu" + tapi.odu.MepAugmentation1: + type: "object" + properties: + odu-mep-spec: + description: "none" + $ref: "#/definitions/tapi.odu.OduMepSpec" + x-augmentation: + prefix: "tapi-odu" + namespace: "urn:onf:otcc:yang:tapi-odu" + tapi.odu.MipAugmentation1: + type: "object" + properties: + odu-mip-spec: + description: "none" + $ref: "#/definitions/tapi.odu.OduMipSpec" + x-augmentation: + prefix: "tapi-odu" + namespace: "urn:onf:otcc:yang:tapi-odu" + tapi.odu.NodeEdgePointAugmentation3: + type: "object" + properties: + odu-node-edge-point-spec: + description: "Augments the base LayerProtocol information in NodeEdgePoint\ + \ with ODU-specific information" + $ref: "#/definitions/tapi.odu.OduNodeEdgePointSpec" + x-augmentation: + prefix: "tapi-odu" + namespace: "urn:onf:otcc:yang:tapi-odu" + tapi.odu.OduCommonPac: + type: "object" + properties: + odu-rate-tolerance: + type: "integer" + format: "int32" + description: "This attribute indicates the rate tolerance of the ODU termination\ + \ point. \r\n Valid values are real value in the unit of\ + \ ppm. \r\n Standardized values are defined in Table 7-2/G.709." + odu-rate: + type: "integer" + format: "int32" + description: "This attribute indicates the rate of the ODU terminatino point.\ + \ \r\n This attribute is Set at create; i.e., once created\ + \ it cannot be changed directly. \r\n In case of resizable\ + \ ODU flex, its value can be changed via HAO (not directly on the attribute).\ + \ \r\n " + odu-type: + type: "string" + description: "This attribute specifies the type of the ODU termination point." + tapi.odu.OduConnectionEndPointSpec: + type: "object" + properties: + odu-term-and-adapter: + description: "none" + $ref: "#/definitions/tapi.odu.OduTerminationAndClientAdaptationPac" + odu-common: + description: "none" + $ref: "#/definitions/tapi.odu.OduCommonPac" + odu-ctp: + description: "none" + $ref: "#/definitions/tapi.odu.OduCtpPac" + odu-protection: + description: "none" + $ref: "#/definitions/tapi.odu.OduProtectionPac" + tapi.odu.OduConnectivityServiceEndPointSpec: + type: "object" + properties: + accepted-payload-type: + description: "This attribute is applicable when the ODU CTP object instance\ + \ represents a lower order ODU CTP Sink at the client layer of the ODUP/ODU[i]j\ + \ or ODUP/ODUj-21 adaptation function. \r\n This attribute\ + \ is a 2-digit Hex code that indicates the new accepted payload type.\r\n\ + \ Valid values are defined in Table 15-8 of ITU-T Recommendation\ + \ G.709 with one additional value UN_INTERPRETABLE." + $ref: "#/definitions/tapi.odu.OduPayloadType" + opu-tributary-slot-size: + description: "This attribute is applicable for ODU2 and ODU3 CTP only. It\ + \ indicates the slot size of the ODU CTP." + $ref: "#/definitions/tapi.odu.OduSlotSize" + tributary-port-number: + type: "integer" + format: "int32" + description: "This attribute identifies the tributary port number that is\ + \ associated with the ODU CTP.\r\n range of type : The value\ + \ range depends on the size of the Tributary Port Number (TPN) field used\ + \ which depends on th server-layer ODU or OTU.\r\n In case\ + \ of ODUk mapping into OTUk, there is no TPN field, so the tributaryPortNumber\ + \ shall be zero.\r\n In case of LO ODUj mapping over ODU1,\ + \ ODU2 or ODU3, the TPN is encoded in a 6-bit field so the value range is\ + \ 0-63. See clause 14.4.1/G.709-2016.\r\n In case of LO ODUj\ + \ mapping over ODU4, the TPN is encoded in a 7-bit field so the value range\ + \ is 0-127. See clause 14.4.1.4/G.709-2016.\r\n In case of\ + \ ODUk mapping over ODUCn, the TPN is encoded in a 14-bit field so the value\ + \ range is 0-16383. See clause 20.4.1.1/G.709-2016.\r\n " + tributary-slot-list: + type: "array" + description: "This attribute contains a set of distinct (i.e. unique) integers\ + \ (e.g. 2, 3, 5, 9, 15 representing the tributary slots TS2, TS3, TS5, TS9\ + \ and TS15) which represents the resources occupied by the Low Order ODU\ + \ Link Connection (e.g. carrying an ODUflex with a bit rate of 6.25G). \r\ + \n This attribute applies when the LO ODU_ ConnectionTerminationPoint\ + \ connects with an HO ODU_TrailTerminationPoint object. \r\n \ + \ It will not apply if this ODU_ ConnectionTerminationPoint object directly\ + \ connects to an OTU_TrailTerminationPoint object (i.e. OTU has no trib\ + \ slots). \r\n The upper bound of the integer allowed in\ + \ this set is a function of the HO-ODU server layer to which the ODU connection\ + \ has been mapped (adapted). \r\n Thus, for example, M=8/32/80\ + \ for ODU2/ODU3/ODU4 server layers (respectively). Note that the value of\ + \ this attribute can be changed only in the case of ODUflex and has to be\ + \ through specific operations (i.e. not be changing the attribute tributarySlotList\ + \ directly)." + items: + type: "integer" + format: "int32" + configured-mapping-type: + description: "This attributes indicates the configured mapping type." + $ref: "#/definitions/tapi.odu.MappingType" + odu-type: + type: "string" + description: "This attribute specifies the type of the ODU termination point." + tapi.odu.OduCtpPac: + type: "object" + properties: + accepted-msi: + type: "string" + description: "This attribute is applicable when the ODU CTP object instance\ + \ represents a lower order ODU1 or ODU2 CTP Sink at the client layer of\ + \ the ODU3P/ODU12 adaptation function or represents a lower order ODUj CTP\ + \ Sink at the client layer of the ODUP/ODUj-21 adaptation function. This\ + \ attribute is a 1-byte field that represents the accepted multiplex structure\ + \ of the adaptation function. " + tributary-port-number: + type: "integer" + format: "int32" + description: "This attribute identifies the tributary port number that is\ + \ associated with the ODU CTP.\r\n range of type : The value\ + \ range depends on the size of the Tributary Port Number (TPN) field used\ + \ which depends on th server-layer ODU or OTU.\r\n In case\ + \ of ODUk mapping into OTUk, there is no TPN field, so the tributaryPortNumber\ + \ shall be zero.\r\n In case of LO ODUj mapping over ODU1,\ + \ ODU2 or ODU3, the TPN is encoded in a 6-bit field so the value range is\ + \ 0-63. See clause 14.4.1/G.709-2016.\r\n In case of LO ODUj\ + \ mapping over ODU4, the TPN is encoded in a 7-bit field so the value range\ + \ is 0-127. See clause 14.4.1.4/G.709-2016.\r\n In case of\ + \ ODUk mapping over ODUCn, the TPN is encoded in a 14-bit field so the value\ + \ range is 0-16383. See clause 20.4.1.1/G.709-2016.\r\n " + tributary-slot-list: + type: "array" + description: "This attribute contains a set of distinct (i.e. unique) integers\ + \ (e.g. 2, 3, 5, 9, 15 representing the tributary slots TS2, TS3, TS5, TS9\ + \ and TS15) which represents the resources occupied by the Low Order ODU\ + \ Link Connection (e.g. carrying an ODUflex with a bit rate of 6.25G). \r\ + \n This attribute applies when the LO ODU_ ConnectionTerminationPoint\ + \ connects with an HO ODU_TrailTerminationPoint object. \r\n \ + \ It will not apply if this ODU_ ConnectionTerminationPoint object directly\ + \ connects to an OTU_TrailTerminationPoint object (i.e. OTU has no trib\ + \ slots). \r\n The upper bound of the integer allowed in\ + \ this set is a function of the HO-ODU server layer to which the ODU connection\ + \ has been mapped (adapted). \r\n Thus, for example, M=8/32/80\ + \ for ODU2/ODU3/ODU4 server layers (respectively). Note that the value of\ + \ this attribute can be changed only in the case of ODUflex and has to be\ + \ through specific operations (i.e. not be changing the attribute tributarySlotList\ + \ directly)." + items: + type: "integer" + format: "int32" + tapi.odu.OduDefectPac: + type: "object" + properties: + oci: + type: "boolean" + description: "Open Connection Indicator" + default: false + lck: + type: "boolean" + description: "Locked" + default: false + bdi: + type: "boolean" + description: "Backward Defect Indication" + default: false + ssf: + type: "boolean" + description: "Server Signal Failure" + default: false + deg: + type: "boolean" + description: "Signal Degraded" + default: false + tim: + type: "boolean" + description: "Trail Trace Identifier Mismatch" + default: false + tapi.odu.OduMegSpec: + type: "object" + properties: + meg-level: + type: "integer" + format: "int32" + description: "none" + tapi.odu.OduMepPac: + allOf: + - $ref: "#/definitions/tapi.odu.OduMipPac" + - type: "object" + properties: + dm-source: + type: "boolean" + description: "This attribute is for configuring the delay measurement process\ + \ at the trail termination function represented by the subject TTP object\ + \ class. It models the MI_DM_Source MI signal. If MI_DM_Source is false,\ + \ then the value of the DMp bit is determined by the RI_DM. If MI_DM_Source\ + \ is true, then the value of the DMp bit is set to MI_DMValue." + default: false + dm-value: + type: "boolean" + description: "This attribute is for setting the DMp and DMti bits of the\ + \ delay measurement process. The value of 'true' sets the DMp and DMti\ + \ bits to 0 and the value of 'false' to 1." + default: false + txti: + type: "string" + description: "The Trail Trace Identifier (TTI) information, provisioned\ + \ by the managing system at the termination source, to be placed in the\ + \ TTI overhead position of the source of a trail for transmission.\r\n\ + \ " + description: "none" + tapi.odu.OduMepSpec: + type: "object" + properties: + odu-pm: + description: "none" + $ref: "#/definitions/tapi.odu.OduPmPac" + odu-ncm: + description: "none" + $ref: "#/definitions/tapi.odu.OduNcmPac" + odu-mep: + description: "none" + $ref: "#/definitions/tapi.odu.OduMepPac" + odu-tcm: + description: "none" + $ref: "#/definitions/tapi.odu.OduTcmMepPac" + odu-defect: + description: "none" + $ref: "#/definitions/tapi.odu.OduDefectPac" + tapi.odu.OduMipPac: + type: "object" + properties: + tim-det-mode: + description: "This attribute indicates the mode of the Trace Identifier Mismatch\ + \ (TIM) Detection function allowed values: OFF, SAPIonly, DAPIonly, SAPIandDAPI" + $ref: "#/definitions/tapi.odu.TimDetMo" + ex-dapi: + type: "string" + description: "The Expected Destination Access Point Identifier (ExDAPI), provisioned\ + \ by the managing system, to be compared with the TTI accepted at the overhead\ + \ position of the sink for the purpose of checking the integrity of connectivity." + deg-m: + type: "integer" + format: "int32" + description: "This attribute indicates the threshold level for declaring a\ + \ Degraded Signal defect (dDEG). A dDEG shall be declared if DegM consecutive\ + \ bad PM Seconds are detected." + acti: + type: "string" + description: "The Trail Trace Identifier (TTI) information recovered (Accepted)\ + \ from the TTI overhead position at the sink of a trail." + ex-sapi: + type: "string" + description: "The Expected Source Access Point Identifier (ExSAPI), provisioned\ + \ by the managing system, to be compared with the TTI accepted at the overhead\ + \ position of the sink for the purpose of checking the integrity of connectivity.\r\ + \n " + deg-thr: + description: "This attribute indicates the threshold level for declaring a\ + \ performance monitoring (PM) Second to be bad. The value of the threshold\ + \ can be provisioned in terms of number of errored blocks or in terms of\ + \ percentage of errored blocks. For percentage-based specification, in order\ + \ to support provision of less than 1%, the specification consists of two\ + \ fields. The first field indicates the granularity of percentage. For examples,\ + \ in 1%, in 0.1%, or in 0.01%, etc. The second field indicates the multiple\ + \ of the granularity. For number of errored block based, the value is a\ + \ positive integer." + $ref: "#/definitions/tapi.odu.DegThr" + tim-act-disabled: + type: "boolean" + description: "This attribute provides the control capability for the managing\ + \ system to enable or disable the Consequent Action function when detecting\ + \ Trace Identifier Mismatch (TIM) at the trail termination sink." + default: true + tapi.odu.OduMipSpec: + type: "object" + properties: + odu-mip: + description: "none" + $ref: "#/definitions/tapi.odu.OduMipPac" + odu-pm: + description: "none" + $ref: "#/definitions/tapi.odu.OduPmPac" + odu-ncm: + description: "none" + $ref: "#/definitions/tapi.odu.OduNcmPac" + odu-tcm: + description: "none" + $ref: "#/definitions/tapi.odu.OduTcmMipPac" + odu-defect: + description: "none" + $ref: "#/definitions/tapi.odu.OduDefectPac" + tapi.odu.OduNamedPayloadType: + type: "string" + enum: + - "UNKNOWN" + - "UNINTERPRETABLE" + tapi.odu.OduNcmPac: + type: "object" + properties: + tcm-fields-in-use: + type: "array" + description: "This attribute indicates the used TCM fields of the ODU OH." + items: + type: "integer" + format: "int32" + tapi.odu.OduNodeEdgePointSpec: + type: "object" + properties: + odu-pool: + description: "none" + $ref: "#/definitions/tapi.odu.OduPoolPac" + tapi.odu.OduPayloadType: + type: "object" + properties: + hex-payload-type: + type: "integer" + format: "int32" + description: "none" + named-payload-type: + description: "none" + $ref: "#/definitions/tapi.odu.OduNamedPayloadType" + tapi.odu.OduPmPac: + type: "object" + properties: + f-ses: + type: "integer" + format: "int32" + description: "Far-end Severely Errored Second" + n-bbe: + type: "integer" + format: "int32" + description: "Near-end Background Block Error" + f-bbe: + type: "integer" + format: "int32" + description: "Far-end Background Block Error" + uas: + description: "UnAvailable Second" + $ref: "#/definitions/tapi.odu.UasChoice" + n-ses: + type: "integer" + format: "int32" + description: "Near-end Severely Errored Second" + tapi.odu.OduPoolPac: + type: "object" + properties: + client-capacity: + type: "integer" + format: "int32" + description: "none" + max-client-size: + type: "integer" + format: "int32" + description: "none" + max-client-instances: + type: "integer" + format: "int32" + description: "none" + tapi.odu.OduProtectionPac: + type: "object" + properties: + aps-enable: + type: "boolean" + description: "This attribute is for enabling/disabling the automatic protection\ + \ switching (APS) capability at the transport adaptation function that is\ + \ represented by the ODU_ConnectionTerminationPoint object class. It triggers\ + \ the MI_APS_EN signal to the transport adaptation function." + default: true + aps-level: + type: "integer" + format: "int32" + description: "This attribute is for configuring the automatic protection switching\ + \ (APS) level that should operate at the transport adaptation function that\ + \ is represented by the ODU_ConnectionTerminationPoint object class. It\ + \ triggers the MI_APS_LVL signal to the transport adaptation function. The\ + \ value 0 means path and the values 1 through 6 mean TCM level 1 through\ + \ 6 respectively." + tapi.odu.OduSlotSize: + type: "string" + enum: + - "1G25" + - "2G5" + tapi.odu.OduTcmMepPac: + type: "object" + properties: + admin-state-sink: + description: "This attribute provides the capability to provision the LOCK\ + \ signal at the sink, which is one of the ODU maintenance signals. When\ + \ a Tandem Connection endpoint is set to admin state locked, it will insert\ + \ the ODU-LCK signal in the downstream direction." + $ref: "#/definitions/tapi.common.AdministrativeState" + codirectional: + type: "boolean" + description: "This attribute specifies the directionality of the ODUT MEP\ + \ with respect to the associated ODU CEP. The value of TRUE means that the\ + \ sink part of the ODUT MEP terminates the same signal direction as the\ + \ sink part of the ODU CEP. The Source part behaves similarly. This attribute\ + \ is meaningful only on objects instantiated under ODU CEP, and at least\ + \ one among ODU CEP and the subordinate object is bidirectional." + default: false + admin-state-source: + description: "This attribute provides the capability to provision the LOCK\ + \ signal at the source, which is one of the ODU maintenance signals. When\ + \ a Tandem Connection endpoint is set to admin state locked, it will insert\ + \ the ODU-LCK signal in the source direction." + $ref: "#/definitions/tapi.common.AdministrativeState" + ac-status-source: + description: "This attribute indicates the status of the accepted TCM. " + $ref: "#/definitions/tapi.odu.TcmStatus" + tcm-extension: + description: "none" + $ref: "#/definitions/tapi.odu.TcmExtension" + ac-status-sink: + description: "This attribute indicates the status of the accepted TCM. " + $ref: "#/definitions/tapi.odu.TcmStatus" + tcm-mode: + description: "This attribute specifies the TCM mode at the entity. Valid values\ + \ are: Operational, Monitor, and Transparent." + $ref: "#/definitions/tapi.odu.TcmMode" + tcm-field: + type: "integer" + format: "int32" + description: "This attribute indicates the tandem connection monitoring field\ + \ of the ODU OH." + tapi.odu.OduTcmMipPac: + type: "object" + properties: + codirectional: + type: "boolean" + description: "This attribute specifies the directionality of the ODU MIP with\ + \ respect to the associated ODU CEP. The value of TRUE means that the (half\ + \ MIP/sink part of the) ODU MIP receives the same signal direction as the\ + \ sink part of the ODU CEP. The Source part behaves similarly. This attribute\ + \ is meaningful only on objects instantiated under ODU CEP, and at least\ + \ one among ODU CEP and the subordinate object is bidirectional." + default: false + tcm-field: + type: "integer" + format: "int32" + description: "This attribute indicates the tandem connection monitoring field\ + \ of the ODU OH." + tapi.odu.OduTerminationAndClientAdaptationPac: + type: "object" + properties: + configured-mapping-type: + description: "This attributes indicates the configured mapping type." + $ref: "#/definitions/tapi.odu.MappingType" + auto-payload-type: + type: "boolean" + description: "This attribute is applicable when the ODU CTP object instance\ + \ represents a lower order ODU CTP Source at the client layer of the ODUP/ODUj-21\ + \ adaptation function. The value of true of this attribute configures that\ + \ the adaptation source function shall fall back to the payload type PT=20\ + \ if the conditions specified in 14.3.10.1/G.798 are satisfied. " + default: false + accepted-payload-type: + description: "This attribute is applicable when the ODU CTP object instance\ + \ represents a lower order ODU CTP Sink at the client layer of the ODUP/ODU[i]j\ + \ or ODUP/ODUj-21 adaptation function. \r\n This attribute\ + \ is a 2-digit Hex code that indicates the new accepted payload type.\r\n\ + \ Valid values are defined in Table 15-8 of ITU-T Recommendation\ + \ G.709 with one additional value UN_INTERPRETABLE." + $ref: "#/definitions/tapi.odu.OduPayloadType" + opu-tributary-slot-size: + description: "This attribute is applicable for ODU2 and ODU3 CTP only. It\ + \ indicates the slot size of the ODU CTP." + $ref: "#/definitions/tapi.odu.OduSlotSize" + configured-client-type: + type: "string" + description: "This attribute configures the type of the client CTP of the\ + \ server ODU TTP." + tapi.odu.PercentageGranularity: + type: "string" + enum: + - "ONES" + - "ONE_TENTHS" + - "ONE_HUNDREDTHS" + - "ONE_THOUSANDTHS" + tapi.odu.TcmExtension: + type: "string" + enum: + - "NORMAL" + - "PASS-THROUGH" + - "ERASE" + tapi.odu.TcmMode: + type: "string" + enum: + - "OPERATIONAL" + - "TRANSPARENT" + - "MONITOR" + tapi.odu.TcmStatus: + type: "string" + enum: + - "NO_SOURCE_TC" + - "IN_USE_WITHOUT_IAE" + - "IN_USE_WITH_IAE" + - "RESERVED_1" + - "RESERVED_2" + - "LCK" + - "OCI" + - "AIS" + tapi.odu.TimDetMo: + type: "string" + enum: + - "DAPI" + - "SAPI" + - "BOTH" + - "OFF" + tapi.odu.UasChoice: + type: "object" + properties: + fuas: + type: "integer" + format: "int32" + description: "none" + bidirectional: + type: "boolean" + description: "none" + default: true + nuas: + type: "integer" + format: "int32" + description: "none" + uas: + type: "integer" + format: "int32" + description: "none" + 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.PathComputationService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology-constraint: + type: "array" + description: "none" + items: + $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" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + optimization-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + direction: + description: "none" + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "none" + tapi.path.computation.PathObjectiveFunction: + allOf: + - $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.PathOptimizationConstraint: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + traffic-interruption: + description: "none" + $ref: "#/definitions/tapi.common.DirectiveValue" + description: "none" + 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.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.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 + tolerable-impact: + type: "string" + description: "Grades of maximum tolerable disruption to traffic." + 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" + 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" + tapi.path.computation.TopologyConstraint: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + include-node: + type: "string" + description: "This is a loose constraint - that is it is unordered and could\ + \ be a partial list" + exclude-link: + type: "string" + description: "none" + avoid-topology: + type: "string" + description: "none" + exclude-path: + type: "string" + description: "none" + include-topology: + type: "string" + description: "none" + include-path: + type: "string" + description: "none" + exclude-node-edge-point: + type: "string" + description: "none" + include-node-edge-point: + type: "string" + description: "none" + include-link: + type: "string" + description: "This is a loose constraint - that is it is unordered and could\ + \ be a partial list " + preferred-transport-layer: + description: "soft constraint requested by client to indicate the layer(s)\ + \ of transport connection that it prefers to carry the service. This could\ + \ be same as the service layer or one of the supported server layers" + $ref: "#/definitions/tapi.common.LayerProtocolName" + exclude-node: + type: "string" + description: "none" + constraint-weight: + type: "integer" + format: "int32" + description: "Zero and positive values: zero means 'strongly required to\ + \ be included', +1 means 'less strongly required to be included', etc.\r\ + \n For example the work/intended route will be calculated\ + \ considering the topologies which weights are lowest (but not negative).\r\ + \n Negative values: -1 means 'strongly required to be excluded',\ + \ -2 means 'less strongly required to be excluded', etc." + description: "The TopologyConstraint allows to specify topology entities in\ + \ order to impose specific constraints (as denoted by the attribute name)\ + \ on Connectivity/Path.\r\n The topology entities are specified\ + \ by their instance uuid rather than using references/path (to allow for mapping\ + \ to Yang 1.0).\r\n This loose typing and reference necessitates\ + \ that implementations validate not only the presence of the instance, but\ + \ also that it is of the correct type as implied by the attribute name.\r\n\ + \ If this validation fails, then the implementation is expceted\ + \ to return an error.\r\n " + tapi.path.computation.computep2ppath.Input: + type: "object" + properties: + topology-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.TopologyConstraint" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" + objective-function: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.path.computation.computep2ppath.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathComputationService" + tapi.path.computation.deletep2ppath.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.path.computation.deletep2ppath.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathComputationService" + tapi.path.computation.optimizep2ppath.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + routing-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.RoutingConstraint" + optimization-constraint: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + objective-function: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" + tapi.path.computation.optimizep2ppath.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.path.computation.PathComputationService" + tapi.photonic.media.AdjustmentGranularity: + type: "string" + enum: + - "G_100GHZ" + - "G_50GHZ" + - "G_25GHZ" + - "G_12_5GHZ" + - "G_6_25GHZ" + - "G_3_125GHZ" + - "UNCONSTRAINED" + tapi.photonic.media.ApplicationIdentifier: + type: "object" + properties: + application-identifier-type: + description: "The ITU-T recommendation which defines the application code\ + \ format." + $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifierType" + application-code: + type: "string" + description: "none" + tapi.photonic.media.ApplicationIdentifierType: + type: "string" + enum: + - "PROPRIETARY" + - "ITUT_G959_1" + - "ITUT_G698_1" + - "ITUT_G698_2" + - "ITUT_G696_1" + - "ITUT_G695" + tapi.photonic.media.CentralFrequency: + type: "object" + properties: + central-frequency: + type: "integer" + format: "int32" + description: "The central frequency of the laser specified in MHz. It is the\ + \ oscillation frequency of the corresponding electromagnetic wave. " + frequency-constraint: + description: "none" + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + tapi.photonic.media.CentralFrequencyBand: + type: "object" + properties: + upper-central-frequency: + type: "integer" + format: "int32" + description: "The upper central frequency that can be tuned in the laser specified\ + \ in MHz.\r\n It is the oscillation frequency of the corresponding\ + \ electromagnetic wave. " + lower-central-frequency: + type: "integer" + format: "int32" + description: "The lower central frequency that can be tuned in the laser specified\ + \ in MHz.\r\n It is the oscillation frequency of the corresponding\ + \ electromagnetic wave. " + frequency-constraint: + description: "none" + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + tapi.photonic.media.ConnectionEndPointAugmentation1: + type: "object" + properties: + otsi-assembly-connection-end-point-spec: + description: "none" + $ref: "#/definitions/tapi.photonic.media.OtsiAssemblyConnectionEndPointSpec" + x-augmentation: + prefix: "tapi-photonic-media" + namespace: "urn:onf:otcc:yang:tapi-photonic-media" + tapi.photonic.media.ConnectionEndPointAugmentation2: + type: "object" + properties: + otsi-connection-end-point-spec: + description: "none" + $ref: "#/definitions/tapi.photonic.media.OtsiConnectionEndPointSpec" + x-augmentation: + prefix: "tapi-photonic-media" + namespace: "urn:onf:otcc:yang:tapi-photonic-media" + tapi.photonic.media.ConnectionEndPointAugmentation3: + type: "object" + properties: + media-channel-connection-end-point-spec: + description: "none" + $ref: "#/definitions/tapi.photonic.media.MediaChannelConnectionEndPointSpec" + x-augmentation: + prefix: "tapi-photonic-media" + namespace: "urn:onf:otcc:yang:tapi-photonic-media" + tapi.photonic.media.EndPointAugmentation1: + type: "object" + properties: + otsi-connectivity-service-end-point-spec: + description: "none" + $ref: "#/definitions/tapi.photonic.media.OtsiConnectivityServiceEndPointSpec" + x-augmentation: + prefix: "tapi-photonic-media" + namespace: "urn:onf:otcc:yang:tapi-photonic-media" + tapi.photonic.media.EndPointAugmentation2: + type: "object" + properties: + media-channel-connectivity-service-end-point-spec: + description: "none" + $ref: "#/definitions/tapi.photonic.media.MediaChannelConnectivityServiceEndPointSpec" + x-augmentation: + prefix: "tapi-photonic-media" + namespace: "urn:onf:otcc:yang:tapi-photonic-media" + tapi.photonic.media.FecProperties: + type: "object" + properties: + uncorrectable-bytes: + type: "integer" + format: "int32" + description: "Bytes that could not be corrected by FEC" + corrected-bits: + type: "integer" + format: "int32" + description: "Bits corrected between those that were received corrupted" + pre-fec-ber: + type: "integer" + format: "int32" + description: "counter: bit error rate before correction by FEC" + uncorrectable-bits: + type: "integer" + format: "int32" + description: "Bits that could not be corrected by FEC" + corrected-bytes: + type: "integer" + format: "int32" + description: "Bytes corrected between those that were received corrupted" + post-fec-ber: + type: "integer" + format: "int32" + description: "counter: bit error rate after correction by FEC" + tapi.photonic.media.FrequencyConstraint: + type: "object" + properties: + adjustment-granularity: + description: "Adjustment granularity in Gigahertz. As per ITU-T G.694.1, it\ + \ is used to calculate nominal central frequency (in THz)" + $ref: "#/definitions/tapi.photonic.media.AdjustmentGranularity" + grid-type: + description: "Specifies the frequency grid standard used to determine the\ + \ nominal central frequency and frequency slot width" + $ref: "#/definitions/tapi.photonic.media.GridType" + tapi.photonic.media.GridType: + type: "string" + enum: + - "DWDM" + - "CWDM" + - "FLEX" + - "GRIDLESS" + - "UNSPECIFIED" + tapi.photonic.media.LaserControlStatusType: + type: "string" + enum: + - "ON" + - "OFF" + - "PULSING" + - "UNDEFINED" + tapi.photonic.media.LaserControlType: + type: "string" + enum: + - "FORCED-ON" + - "FORCED-OFF" + - "AUTOMATIC-LASER-SHUTDOWN" + - "UNDEFINED" + tapi.photonic.media.LaserProperties: + type: "object" + properties: + laser-application-type: + description: "The type of laser, its operational wavelengths, and its applications.\ + \ String size 255." + $ref: "#/definitions/tapi.photonic.media.LaserType" + laser-bias-current: + type: "string" + description: "The Bias current of the laser that is the medium polarization\ + \ current of the laser." + laser-temperature: + type: "string" + description: "The temperature of the laser" + laser-status: + description: "none" + $ref: "#/definitions/tapi.photonic.media.LaserControlStatusType" + tapi.photonic.media.LaserType: + type: "string" + enum: + - "PUMP" + - "MODULATED" + - "PULSE" + tapi.photonic.media.MediaChannelConfigPac: + type: "object" + properties: + spectrum: + description: "none" + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + tapi.photonic.media.MediaChannelConnectionEndPointSpec: + type: "object" + properties: + media-channel: + description: "none" + $ref: "#/definitions/tapi.photonic.media.MediaChannelPropertiesPac" + tapi.photonic.media.MediaChannelConnectivityServiceEndPointSpec: + type: "object" + properties: + power-management-config: + description: "This parameters shall be used to configure the expected\r\n\ + \ and intended (desired) power levels at the endpoints of\ + \ the media\r\n Channel connectivity service. These parameters\ + \ are dependent of the\r\n related OTSi power-management\ + \ capabilities exposed at the SIPs" + $ref: "#/definitions/tapi.photonic.media.PowerManagementConfigPac" + mc-config: + description: "none" + $ref: "#/definitions/tapi.photonic.media.MediaChannelConfigPac" + tapi.photonic.media.MediaChannelNodeEdgePointSpec: + type: "object" + properties: + mc-pool: + description: "none" + $ref: "#/definitions/tapi.photonic.media.MediaChannelPoolCapabilityPac" + tapi.photonic.media.MediaChannelPoolCapabilityPac: + type: "object" + properties: + available-spectrum: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + supportable-spectrum: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + occupied-spectrum: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + tapi.photonic.media.MediaChannelPropertiesPac: + type: "object" + properties: + occupied-spectrum: + description: "none" + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + measured-power-egress: + description: "none" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + measured-power-ingress: + description: "none" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + tapi.photonic.media.MediaChannelServiceInterfacePointSpec: + type: "object" + properties: + mc-pool: + description: "none" + $ref: "#/definitions/tapi.photonic.media.MediaChannelPoolCapabilityPac" + power-management-capability: + description: "none" + $ref: "#/definitions/tapi.photonic.media.PowerManagementCapabilityPac" + tapi.photonic.media.ModulationTechnique: + type: "string" + enum: + - "RZ" + - "NRZ" + - "BPSK" + - "DPSK" + - "QPSK" + - "8QAM" + - "16QAM" + - "PAM4" + - "PAM8" + - "UNDEFINED" + tapi.photonic.media.NodeEdgePointAugmentation1: + type: "object" + properties: + media-channel-node-edge-point-spec: + description: "none" + $ref: "#/definitions/tapi.photonic.media.MediaChannelNodeEdgePointSpec" + x-augmentation: + prefix: "tapi-photonic-media" + namespace: "urn:onf:otcc:yang:tapi-photonic-media" + tapi.photonic.media.NodeEdgePointAugmentation2: + type: "object" + properties: + media-channel-node-edge-point-spec: + description: "Augments the base LayerProtocol information in NodeEdgePoint\ + \ with OCH-specific information" + $ref: "#/definitions/tapi.photonic.media.MediaChannelNodeEdgePointSpec" + x-augmentation: + prefix: "tapi-photonic-media" + namespace: "urn:onf:otcc:yang:tapi-photonic-media" + tapi.photonic.media.OtsiAssemblyConnectionEndPointSpec: + type: "object" + properties: + otsi-adapter: + description: "none" + $ref: "#/definitions/tapi.photonic.media.OtsiServerAdaptationPac" + tapi.photonic.media.OtsiCapabilityPac: + type: "object" + properties: + supportable-application-identifier: + type: "array" + description: "The list of supportable ApplicationIdentifiers." + items: + $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifier" + supportable-modulation: + type: "array" + description: "This parameter defines the modulation used at the source" + items: + $ref: "#/definitions/tapi.photonic.media.ModulationTechnique" + total-power-warn-threshold: + description: "none" + $ref: "#/definitions/tapi.photonic.media.TotalPowerThresholdPac" + supportable-central-frequency-band: + type: "array" + description: "Each spectrum band supported for otsi trasmitter to be tuned\ + \ on, is specified\r\n as per it's lower and upper central\ + \ frequencies supported and its frequency constraints,\r\n \ + \ consisting in the frequency Grid and the AdjustmentGranularity, used\ + \ to uniquely identify all\r\n central frequencies supported\ + \ within the band." + items: + $ref: "#/definitions/tapi.photonic.media.CentralFrequencyBand" + tapi.photonic.media.OtsiConnectionEndPointSpec: + type: "object" + properties: + otsi-termination: + description: "none" + $ref: "#/definitions/tapi.photonic.media.OtsiTerminationPac" + tapi.photonic.media.OtsiConnectivityServiceEndPointSpec: + type: "object" + properties: + otsi-config: + description: "none" + $ref: "#/definitions/tapi.photonic.media.OtsiTerminationConfigPac" + tapi.photonic.media.OtsiServerAdaptationPac: + type: "object" + properties: + fec-parameters: + description: "none" + $ref: "#/definitions/tapi.photonic.media.FecProperties" + number-of-otsi: + type: "integer" + format: "int32" + description: "none" + tapi.photonic.media.OtsiServiceInterfacePointSpec: + type: "object" + properties: + otsi-capability: + description: "none" + $ref: "#/definitions/tapi.photonic.media.OtsiCapabilityPac" + power-management-capability: + description: "none" + $ref: "#/definitions/tapi.photonic.media.PowerManagementCapabilityPac" + tapi.photonic.media.OtsiTerminationConfigPac: + type: "object" + properties: + application-identifier: + description: "This attribute indicates the selected Application Identifier." + $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifier" + central-frequency: + description: "The central frequency of the laser. It is the oscillation frequency\ + \ of the corresponding electromagnetic wave" + $ref: "#/definitions/tapi.photonic.media.CentralFrequency" + modulation: + description: "The modulation techniqu selected at the source." + $ref: "#/definitions/tapi.photonic.media.ModulationTechnique" + spectrum: + description: "none" + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + laser-control: + description: "Laser control can be FORCED-ON, FORCED-OFF or LASER-SHUTDOWN" + $ref: "#/definitions/tapi.photonic.media.LaserControlType" + total-power-warn-threshold-lower: + type: "string" + description: "Allows to configure the Lowerpower threshold which is expected\ + \ to be different from Default, but within the Min and Max values specified\ + \ as OTSi SIP capability." + total-power-warn-threshold-upper: + type: "string" + description: "Allows to configure the Upper power threshold which is expected\ + \ to be different from Default, but within the Min and Max values specified\ + \ as OTSi SIP capability." + transmit-power: + description: "Transmit power as requested." + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + tapi.photonic.media.OtsiTerminationPac: + type: "object" + properties: + selected-application-identifier: + description: "This attribute indicates the selected Application Identifier\ + \ that is used by the OCh trail termination function. The syntax of ApplicationIdentifier\ + \ is a pair {ApplicationIdentifierType, PrintableString}. The value of ApplicationIdentifierType\ + \ is either STANDARD or PROPRIETARY. The value of PrintableString represents\ + \ the standard application code as defined in the ITU-T Recommendations\ + \ or a vendor-specific proprietary code. If the ApplicationIdentifierType\ + \ is STANDARD the value of PrintableString represents a standard application\ + \ code as defined in the ITU-T Recommendations. If the ApplicationIdentifierType\ + \ is PROPRIETARY, the first six characters of the PrintableString must contain\ + \ the Hexadecimal representation of an OUI assigned to the vendor whose\ + \ implementation generated the Application Identifier; the remaining octets\ + \ of the PrintableString are unspecified. The value of this attribute of\ + \ an object instance has to be one of the values identified in the attribute\ + \ SupportableApplicationIdentifierList of the same object instance. The\ + \ values and value ranges of the optical interface parameters of a standard\ + \ application code must be consistent with those values specified in the\ + \ ITU-T Recommendation for that application code." + $ref: "#/definitions/tapi.photonic.media.ApplicationIdentifier" + received-power: + description: "none" + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + selected-central-frequency: + description: "none" + $ref: "#/definitions/tapi.photonic.media.CentralFrequency" + transmited-power: + description: "Measured power at the Transmitter." + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + selected-modulation: + description: "This parameter defines the modulation used at the source" + $ref: "#/definitions/tapi.photonic.media.SelectedModulation" + laser-properties: + description: "Laser properties." + $ref: "#/definitions/tapi.photonic.media.LaserProperties" + selected-spectrum: + description: "none" + $ref: "#/definitions/tapi.photonic.media.SpectrumBand" + tapi.photonic.media.PowerManagementCapabilityPac: + type: "object" + properties: + tolerable-maximum-input-power: + description: "This parameter exposes the maximum input power tolerated\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + supportable-minimum-output-power: + description: "This parameter exposes the minimum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + tolerable-minimum-input-power: + description: "This parameter exposes the minimum input power tolerated\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + supportable-maximum-output-power: + description: "This parameter exposes the maximum output power supported\r\n\ + \ at the Logical-Termination-Point (LTP) associated to the\ + \ SIP." + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + tapi.photonic.media.PowerManagementConfigPac: + type: "object" + properties: + expected-maximum-input-power: + description: "This parameter shall be used to specify the maximum input power\r\ + \n being received at the Logical-Termination-Point (LTP)\ + \ associated to the CSEP." + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + expected-minimum-input-power: + description: "This parameter shall be used to specify the minimum input power\r\ + \n being received at the Logical-Termination-Point (LTP)\ + \ associated to the CSEP." + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + intended-minimum-output-power: + description: "This parameter shall be used to specify the minimum output power\r\ + \n desired at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + intended-maximum-output-power: + description: "This parameter shall be used to specify the maximum output power\r\ + \n desired at the Logical-Termination-Point (LTP) associated\ + \ to the CSEP." + $ref: "#/definitions/tapi.photonic.media.PowerProperties" + tapi.photonic.media.PowerProperties: + type: "object" + properties: + power-spectral-density: + type: "string" + description: "This describes how power of a signal is distributed over frequency\ + \ specified in nW/MHz" + total-power: + type: "string" + description: "The total power at any point in a channel specified in dBm." + tapi.photonic.media.SelectedModulation: + type: "string" + enum: + - "RZ" + - "NRZ" + - "BPSK" + - "DPSK" + - "QPSK" + - "8QAM" + - "16QAM" + - "PAM4" + - "PAM8" + - "UNDEFINED" + tapi.photonic.media.ServiceInterfacePointAugmentation1: + type: "object" + properties: + otsi-service-interface-point-spec: + description: "none" + $ref: "#/definitions/tapi.photonic.media.OtsiServiceInterfacePointSpec" + x-augmentation: + prefix: "tapi-photonic-media" + namespace: "urn:onf:otcc:yang:tapi-photonic-media" + tapi.photonic.media.ServiceInterfacePointAugmentation2: + type: "object" + properties: + media-channel-service-interface-point-spec: + description: "none" + $ref: "#/definitions/tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + x-augmentation: + prefix: "tapi-photonic-media" + namespace: "urn:onf:otcc:yang:tapi-photonic-media" + tapi.photonic.media.SipAugmentation1: + type: "object" + properties: + media-channel-service-interface-point-spec: + description: "none" + $ref: "#/definitions/tapi.photonic.media.MediaChannelServiceInterfacePointSpec" + x-augmentation: + prefix: "tapi-photonic-media" + namespace: "urn:onf:otcc:yang:tapi-photonic-media" + tapi.photonic.media.SipAugmentation2: + type: "object" + properties: + otsi-service-interface-point-spec: + description: "none" + $ref: "#/definitions/tapi.photonic.media.OtsiServiceInterfacePointSpec" + x-augmentation: + prefix: "tapi-photonic-media" + namespace: "urn:onf:otcc:yang:tapi-photonic-media" + tapi.photonic.media.SpectrumBand: + type: "object" + properties: + lower-frequency: + type: "integer" + format: "int32" + description: "The lower frequency bound of the media channel spectrum specified\ + \ in MHz" + upper-frequency: + type: "integer" + format: "int32" + description: "The upper frequency bound of the media channel spectrum specified\ + \ in MHz" + frequency-constraint: + description: "none" + $ref: "#/definitions/tapi.photonic.media.FrequencyConstraint" + tapi.photonic.media.TotalPowerThresholdPac: + type: "object" + properties: + total-power-upper-warn-threshold-default: + type: "string" + description: "Can read the value of the default threshold that was set" + total-power-lower-warn-threshold-min: + type: "string" + description: "Can read the value of the lower threshold that was set" + total-power-upper-warn-threshold-min: + type: "string" + description: "Can read the value of the lower threshold that was set" + total-power-upper-warn-threshold-max: + type: "string" + description: "Can read the value of the upper threshold that was set" + total-power-lower-warn-threshold-max: + type: "string" + description: "Can read the value of the upper threshold that was set" + total-power-lower-warn-threshold-default: + type: "string" + description: "Can read the value of the default threshold that was set" + tapi.topology.ContextAugmentation5: + type: "object" + properties: + topology-context: + description: "Augments the base TAPI Context with TopologyService information" + $ref: "#/definitions/tapi.topology.TopologyContext" + x-augmentation: + prefix: "tapi-topology" + namespace: "urn:onf:otcc:yang:tapi-topology" + tapi.topology.CostCharacteristic: + type: "object" + properties: + cost-value: + type: "string" + description: "The specific cost." + cost-algorithm: + type: "string" + description: "The cost may vary based upon some properties of the TopologicalEntity.\ + \ The rules for the variation are conveyed by the costAlgorithm." + cost-name: + type: "string" + description: "The cost characteristic will related to some aspect of the TopologicalEntity\ + \ (e.g. $ cost, routing weight). This aspect will be conveyed by the costName." + tapi.topology.ForwardingRule: + type: "string" + enum: + - "MAY_FORWARD_ACROSS_GROUP" + - "MUST_FORWARD_ACROSS_GROUP" + - "CANNOT_FORWARD_ACROSS_GROUP" + - "NO_STATEMENT_ON_FORWARDING" + tapi.topology.GetLinkDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getlinkdetails.Output" + tapi.topology.GetNodeDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getnodedetails.Output" + tapi.topology.GetNodeEdgePointDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Output" + tapi.topology.GetTopologyDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.gettopologydetails.Output" + tapi.topology.GetTopologyList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.gettopologylist.Output" + tapi.topology.InterRuleGroup: + allOf: + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + associated-node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + rule: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Rule" + description: "none" + tapi.topology.LatencyCharacteristic: + type: "object" + properties: + traffic-property-name: + type: "string" + description: "The identifier of the specific traffic property to which the\ + \ queuing latency applies." + jitter-characteristic: + type: "string" + description: "High frequency deviation from true periodicity of a signal and\ + \ therefore a small high rate of change of transfer latency.\r\n \ + \ Applies to TDM systems (and not packet)." + fixed-latency-characteristic: + type: "string" + description: "A TopologicalEntity suffers delay caused by the realization\ + \ of the servers (e.g. distance related; FEC encoding etc.) along with some\ + \ client specific processing. This is the total average latency effect of\ + \ the TopologicalEntity" + wander-characteristic: + type: "string" + description: "Low frequency deviation from true periodicity of a signal and\ + \ therefore a small low rate of change of transfer latency.\r\n \ + \ Applies to TDM systems (and not packet)." + queing-latency-characteristic: + type: "string" + description: "The specific queuing latency for the traffic property." + tapi.topology.LayerProtocolTransitionPac: + type: "object" + properties: + transitioned-layer-protocol-name: + type: "array" + description: "Provides the ordered structure of layer protocol transitions\ + \ encapsulated in the TopologicalEntity. The ordering relates to the LinkPort\ + \ role." + items: + type: "string" + tapi.topology.Link: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.LayerProtocolTransitionPac" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - $ref: "#/definitions/tapi.topology.ValidationPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + restoration-policy: + description: "none" + $ref: "#/definitions/tapi.topology.RestorationPolicy" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" + direction: + description: "The directionality of the Link. \r\n Is applicable\ + \ to simple Links where all LinkEnds are BIDIRECTIONAL (the Link will\ + \ be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ + \ \r\n Is not present in more complex cases." + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "The Link object class models effective adjacency between two or\ + \ more ForwardingDomains (FD). " + tapi.topology.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.NepLayerProtocolCapability: + type: "object" + properties: + layer-protocol-qualifier: + type: "string" + description: "none" + number-of-cep-instances: + type: "integer" + format: "int32" + description: "none" + tapi.topology.NetworkTopologyService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.TopologyRef" + description: "none" + tapi.topology.Node: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + encap-topology: + description: "none" + $ref: "#/definitions/tapi.topology.TopologyRef" + node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePoint" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ + \ topological component which is used to effect forwarding of transport characteristic\ + \ information and offers the potential to enable forwarding. \r\n \ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ multiple switch matrices (FDs). " + tapi.topology.NodeEdgePoint: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.common.TerminationPac" + - type: "object" + properties: + link-port-role: + description: "Each LinkEnd of the Link has a role (e.g., symmetric, hub,\ + \ spoke, leaf, root) in the context of the Link with respect to the Link\ + \ function. " + $ref: "#/definitions/tapi.common.PortRole" + mapped-service-interface-point: + type: "array" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load\ + \ balancing/Resilience) should be considered experimental" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + available-cep-layer-protocol: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + link-port-direction: + description: "The orientation of defined flow at the LinkEnd." + $ref: "#/definitions/tapi.common.PortDirection" + description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ + \ termination and adaptation functions of one or more transport layers. \r\ + \n The structure of LTP supports all transport protocols including\ + \ circuit and packet forms." + tapi.topology.NodeEdgePointRef: + allOf: + - $ref: "#/definitions/tapi.topology.NodeRef" + - type: "object" + properties: + node-edge-point-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-edge-point/tapi-topology:uuid" + description: "none" + tapi.topology.NodeRef: + allOf: + - $ref: "#/definitions/tapi.topology.TopologyRef" + - type: "object" + properties: + node-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:uuid" + description: "none" + tapi.topology.NodeRuleGroup: + allOf: + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + inter-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.InterRuleGroup" + rule: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Rule" + composed-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "none" + tapi.topology.NodeRuleGroupRef: + allOf: + - $ref: "#/definitions/tapi.topology.NodeRef" + - type: "object" + properties: + node-rule-group-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-rule-group/tapi-topology:uuid" + description: "none" + tapi.topology.ProtectionType: + type: "string" + enum: + - "NO_PROTECTION" + - "ONE_PLUS_ONE_PROTECTION" + - "ONE_FOR_ONE_PROTECTION" + - "ONE_FOR_N_PROTECTION" + - "M_FOR_N_PROTECTION" + - "ONE_FOR_ONE_BY_N" + tapi.topology.RestorationPolicy: + type: "string" + enum: + - "PER_DOMAIN_RESTORATION" + - "END_TO_END_RESTORATION" + - "NA" + - "DYNAMIC_RESTORATION" + - "PRE_COMPUTED_RESTORATION" + tapi.topology.RiskCharacteristic: + type: "object" + properties: + risk-characteristic-name: + type: "string" + description: "The name of the risk characteristic. The characteristic may\ + \ be related to a specific degree of closeness. \r\n For\ + \ example a particular characteristic may apply to failures that are localized\ + \ (e.g. to one side of a road) where as another characteristic may relate\ + \ to failures that have a broader impact (e.g. both sides of a road that\ + \ crosses a bridge).\r\n Depending upon the importance of\ + \ the traffic being routed different risk characteristics will be evaluated." + risk-identifier-list: + type: "array" + description: "A list of the identifiers of each physical/geographic unit (with\ + \ the specific risk characteristic) that is related to a segment of the\ + \ TopologicalEntity." + items: + type: "string" + tapi.topology.RiskParameterPac: + type: "object" + properties: + risk-characteristic: + type: "array" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + items: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + tapi.topology.Rule: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + override-priority: + type: "integer" + format: "int32" + description: "none" + forwarding-rule: + description: "none" + $ref: "#/definitions/tapi.topology.ForwardingRule" + rule-type: + description: "none" + $ref: "#/definitions/tapi.topology.RuleType" + description: "none" + tapi.topology.RuleType: + type: "string" + enum: + - "FORWARDING" + - "CAPACITY" + - "COST" + - "TIMING" + - "RISK" + - "GROUPING" + tapi.topology.Topology: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + link: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Link" + node: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Node" + boundary-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ + \ topological component which is used to effect forwarding of transport characteristic\ + \ information and offers the potential to enable forwarding. \r\n \ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ multiple switch matrices (FDs). " + tapi.topology.TopologyContext: + type: "object" + properties: + nw-topology-service: + description: "none" + $ref: "#/definitions/tapi.topology.NetworkTopologyService" + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.TopologyRef: + type: "object" + properties: + topology-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:uuid" + tapi.topology.TransferCostPac: + type: "object" + properties: + cost-characteristic: + type: "array" + description: "The list of costs where each cost relates to some aspect of\ + \ the TopologicalEntity." + items: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + tapi.topology.TransferIntegrityPac: + type: "object" + properties: + error-characteristic: + type: "string" + description: "Describes the degree to which the signal propagated can be errored.\ + \ \r\n Applies to TDM systems as the errored signal will\ + \ be propagated and not packet as errored packets will be discarded." + unavailable-time-characteristic: + type: "string" + description: "Describes the duration for which there may be no valid signal\ + \ propagated." + server-integrity-process-characteristic: + type: "string" + description: "Describes the effect of any server integrity enhancement process\ + \ on the characteristics of the TopologicalEntity." + delivery-order-characteristic: + type: "string" + description: "Describes the degree to which packets will be delivered out\ + \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ + \ maintain strict order." + repeat-delivery-characteristic: + type: "string" + description: "Primarily applies to packet systems where a packet may be delivered\ + \ more than once (in fault recovery for example). \r\n It\ + \ can also apply to TDM where several frames may be received twice due to\ + \ switching in a system with a large differential propagation delay." + loss-characteristic: + type: "string" + description: "Describes the acceptable characteristic of lost packets where\ + \ loss may result from discard due to errors or overflow.\r\n \ + \ Applies to packet systems and not TDM (as for TDM errored signals\ + \ are propagated unless grossly errored and overflow/underflow turns into\ + \ timing slips)." + tapi.topology.TransferTimingPac: + type: "object" + properties: + latency-characteristic: + type: "array" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + items: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + tapi.topology.ValidationMechanism: + type: "object" + properties: + layer-protocol-adjacency-validated: + type: "string" + description: "State of validatiion" + validation-mechanism: + type: "string" + description: "Name of mechanism used to validate adjacency" + validation-robustness: + type: "string" + description: "Quality of validation (i.e. how likely is the stated validation\ + \ to be invalid)" + tapi.topology.ValidationPac: + type: "object" + properties: + validation-mechanism: + type: "array" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." + items: + $ref: "#/definitions/tapi.topology.ValidationMechanism" + tapi.topology.getlinkdetails.Input: + type: "object" + properties: + link-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getlinkdetails.Output: + type: "object" + properties: + link: + description: "none" + $ref: "#/definitions/tapi.topology.Link" + tapi.topology.getnodedetails.Input: + type: "object" + properties: + node-id: + type: "string" + description: "UUID of the Node: An identifier that is universally unique within\ + \ an identifier space, where the identifier space is itself globally unique,\ + \ and immutable.\r\n An UUID carries no semantics with\ + \ respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The canonical\ + \ representation uses lowercase characters.\r\n Pattern:\ + \ [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getnodedetails.Output: + type: "object" + properties: + node: + description: "none" + $ref: "#/definitions/tapi.topology.Node" + tapi.topology.getnodeedgepointdetails.Input: + type: "object" + properties: + node-id: + type: "string" + description: "UUID of the parent Node: An identifier that is universally unique\ + \ within an identifier space, where the identifier space is itself globally\ + \ unique, and immutable.\r\n An UUID carries no semantics\ + \ with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The\ + \ canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Node's Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + node-edge-point-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getnodeedgepointdetails.Output: + type: "object" + properties: + node-edge-point: + description: "none" + $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.output.NodeEdgePoint" + tapi.topology.getnodeedgepointdetails.output.NodeEdgePoint: + allOf: + - $ref: "#/definitions/tapi.photonic.media.NodeEdgePointAugmentation1" + - $ref: "#/definitions/tapi.topology.NodeEdgePoint" + tapi.topology.gettopologydetails.Input: + type: "object" + properties: + topology-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.gettopologydetails.Output: + type: "object" + properties: + topology: + description: "none" + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.gettopologylist.Output: + type: "object" + properties: + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.node.NodeEdgePoint: + allOf: + - $ref: "#/definitions/tapi.connectivity.NodeEdgePointAugmentation1" + - $ref: "#/definitions/tapi.odu.NodeEdgePointAugmentation3" + - $ref: "#/definitions/tapi.photonic.media.NodeEdgePointAugmentation2" + - $ref: "#/definitions/tapi.topology.NodeEdgePoint" + tapi.topology.topology.Node: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + encap-topology: + description: "none" + $ref: "#/definitions/tapi.topology.TopologyRef" + node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.node.NodeEdgePoint" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "none" diff --git a/OAS/tapi-topology@2019-03-31.yaml b/OAS/tapi-topology@2019-03-31.yaml new file mode 100644 index 00000000..e03e4938 --- /dev/null +++ b/OAS/tapi-topology@2019-03-31.yaml @@ -0,0 +1,4780 @@ +--- +swagger: "2.0" +info: + description: "\r\n This module contains TAPI Notification Model definitions.\r\ + \n Source: TapiNotification.uml\r\n Copyright (c) 2018 Open Networking\ + \ Foundation (ONF). All rights reserved.\r\n License: This module is distributed\ + \ under the Apache License 2.0\r\n - The TAPI YANG models included in this\ + \ TAPI release are a *normative* part of the TAPI SDK.\r\n - The YANG specifications\ + \ have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG\ + \ mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Topology\ + \ Model definitions.\r\n Source: TapiTopology.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Common Model\ + \ definitions.\r\n Source: TapiCommon.uml\r\n Copyright (c) 2018\ + \ Open Networking Foundation (ONF). All rights reserved.\r\n License: This\ + \ module is distributed under the Apache License 2.0\r\n - The TAPI YANG\ + \ models included in this TAPI release are a *normative* part of the TAPI SDK.\r\ + \n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases." + version: "2.2.0" + title: "tapi-notification,tapi-topology,tapi-common API" +host: "localhost:1234" +consumes: +- "application/yang-data+json" +produces: +- "application/yang-data+json" +paths: + /data/context/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Context" + description: "none" + parameters: [] + responses: + 200: + description: "tapi.common.Context" + schema: + $ref: "#/definitions/tapi.common.Context" + 400: + description: "Internal error" + post: + tags: + - "tapi-common" + summary: "creates tapi.common.Context" + description: "none" + parameters: + - in: "body" + name: "tapi.common.Context.body-param" + description: "tapi.common.Context to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.Context" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.Context" + description: "none" + parameters: + - in: "body" + name: "tapi.common.Context.body-param" + description: "tapi.common.Context to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.Context" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.Context" + description: "none" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/name/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] + responses: + 200: + description: "tapi.notification.NotificationContext" + schema: + $ref: "#/definitions/tapi.notification.NotificationContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: + - in: "body" + name: "tapi.notification.NotificationContext.body-param" + description: "tapi.notification.NotificationContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: + - in: "body" + name: "tapi.notification.NotificationContext.body-param" + description: "tapi.notification.NotificationContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - in: "body" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NotificationSubscriptionService" + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/name/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/notification-channel/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationChannel" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NotificationChannel" + schema: + $ref: "#/definitions/tapi.notification.NotificationChannel" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.Notification" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.Notification" + schema: + $ref: "#/definitions/tapi.notification.Notification" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.SubscriptionFilter" + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + 400: + description: "Internal error" + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notification={uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.Notification" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.Notification" + schema: + $ref: "#/definitions/tapi.notification.Notification" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/additional-info={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/service-interface-point/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - in: "body" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/service-interface-point={uuid}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePoint" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/available-capacity/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/name/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/service-interface-point={uuid}/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/total-potential-capacity/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] + responses: + 200: + description: "tapi.topology.TopologyContext" + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-topology" + summary: "creates tapi.topology.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: + - in: "body" + name: "tapi.topology.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-topology" + summary: "creates or updates tapi.topology.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: + - in: "body" + name: "tapi.topology.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-topology" + summary: "removes tapi.topology.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/topology-context/nw-topology-service/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NetworkTopologyService" + description: "none" + parameters: [] + responses: + 200: + description: "tapi.topology.NetworkTopologyService" + schema: + $ref: "#/definitions/tapi.topology.NetworkTopologyService" + 400: + description: "Internal error" + /data/context/topology-context/nw-topology-service/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.TopologyRef" + description: "none" + parameters: + - name: "topology-uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.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.Topology" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/boundary-node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Link" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Link" + schema: + $ref: "#/definitions/tapi.topology.Link" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.ValidationMechanism" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "validation-mechanism" + in: "path" + description: "Id of validation-mechanism" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.ValidationMechanism" + schema: + $ref: "#/definitions/tapi.topology.ValidationMechanism" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.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.Node" + schema: + $ref: "#/definitions/tapi.topology.Node" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.TopologyRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePoint" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePoint" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{aggregated-node-edge-point-node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-cep-layer-protocol={layer-protocol-qualifier}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NepLayerProtocolCapability" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "layer-protocol-qualifier" + in: "path" + description: "Id of available-cep-layer-protocol" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NepLayerProtocolCapability" + schema: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load balancing/Resilience)\ + \ should be considered experimental" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "service-interface-point-uuid" + in: "path" + description: "Id of mapped-service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePointRef" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroup" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroup" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-rule-group-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroupRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.InterRuleGroup" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.InterRuleGroup" + schema: + $ref: "#/definitions/tapi.topology.InterRuleGroup" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + - name: "associated-node-rule-group-node-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + - name: "associated-node-rule-group-node-rule-group-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroupRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Rule" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Rule" + schema: + $ref: "#/definitions/tapi.topology.Rule" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-node-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Rule" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Rule" + schema: + $ref: "#/definitions/tapi.topology.Rule" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /operations/create-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.CreateNotificationSubscriptionService" + description: "operates on tapi.notification.CreateNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.CreateNotificationSubscriptionService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.DeleteNotificationSubscriptionService" + description: "operates on tapi.notification.DeleteNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.deletenotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-link-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetLinkDetails" + description: "operates on tapi.topology.GetLinkDetails" + parameters: + - in: "body" + name: "tapi.topology.getlinkdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getlinkdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetLinkDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-node-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetNodeDetails" + description: "operates on tapi.topology.GetNodeDetails" + parameters: + - in: "body" + name: "tapi.topology.getnodedetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getnodedetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetNodeDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-node-edge-point-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetNodeEdgePointDetails" + description: "operates on tapi.topology.GetNodeEdgePointDetails" + parameters: + - in: "body" + name: "tapi.topology.getnodeedgepointdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetNodeEdgePointDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-list/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationList" + description: "operates on tapi.notification.GetNotificationList" + parameters: + - in: "body" + name: "tapi.notification.getnotificationlist.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.getnotificationlist.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-subscription-service-details/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + description: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + parameters: + - in: "body" + name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-subscription-service-list/: + post: + tags: + - "tapi-notification" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-service-interface-point-details/: + post: + tags: + - "tapi-common" + summary: "operates on tapi.common.GetServiceInterfacePointDetails" + description: "operates on tapi.common.GetServiceInterfacePointDetails" + parameters: + - in: "body" + name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.common.GetServiceInterfacePointDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-service-interface-point-list/: + post: + tags: + - "tapi-common" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.common.GetServiceInterfacePointList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-supported-notification-types/: + post: + tags: + - "tapi-notification" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetSupportedNotificationTypes" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-topology-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetTopologyDetails" + description: "operates on tapi.topology.GetTopologyDetails" + parameters: + - in: "body" + name: "tapi.topology.gettopologydetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.gettopologydetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetTopologyDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-topology-list/: + post: + tags: + - "tapi-topology" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetTopologyList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.UpdateNotificationSubscriptionService" + description: "operates on tapi.notification.UpdateNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.UpdateNotificationSubscriptionService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-service-interface-point/: + post: + tags: + - "tapi-common" + summary: "operates on tapi.common.UpdateServiceInterfacePoint" + description: "operates on tapi.common.UpdateServiceInterfacePoint" + parameters: + - in: "body" + name: "tapi.common.updateserviceinterfacepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.common.updateserviceinterfacepoint.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" +definitions: + tapi.common.AdminStatePac: + type: "object" + properties: + operational-state: + description: "none" + $ref: "#/definitions/tapi.common.OperationalState" + lifecycle-state: + description: "none" + $ref: "#/definitions/tapi.common.LifecycleState" + administrative-state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + tapi.common.AdministrativeState: + type: "string" + enum: + - "LOCKED" + - "UNLOCKED" + tapi.common.Capacity: + type: "object" + properties: + total-size: + description: "Total capacity of the TopologicalEntity in MB/s. In case of\ + \ bandwidthProfile, this is expected to same as the committedInformationRate." + $ref: "#/definitions/tapi.common.CapacityValue" + tapi.common.CapacityPac: + type: "object" + properties: + available-capacity: + description: "Capacity available to be assigned." + $ref: "#/definitions/tapi.common.Capacity" + total-potential-capacity: + description: "An optimistic view of the capacity of the TopologicalEntity\ + \ assuming that any shared capacity is available to be taken." + $ref: "#/definitions/tapi.common.Capacity" + tapi.common.CapacityUnit: + type: "string" + enum: + - "TB" + - "TBPS" + - "GB" + - "GBPS" + - "MB" + - "MBPS" + - "KB" + - "KBPS" + - "GHz" + - "MHz" + tapi.common.CapacityValue: + type: "object" + properties: + value: + type: "integer" + format: "int32" + description: "none" + unit: + description: "none" + $ref: "#/definitions/tapi.common.CapacityUnit" + tapi.common.Context: + allOf: + - $ref: "#/definitions/tapi.common.TapiContext" + - $ref: "#/definitions/tapi.notification.ContextAugmentation1" + - $ref: "#/definitions/tapi.topology.ContextAugmentation2" + tapi.common.ForwardingDirection: + type: "string" + enum: + - "BIDIRECTIONAL" + - "UNIDIRECTIONAL" + - "UNDEFINED_OR_UNKNOWN" + tapi.common.GetServiceInterfacePointDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Output" + tapi.common.GetServiceInterfacePointList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.common.getserviceinterfacepointlist.Output" + tapi.common.GlobalClass: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a UUID\ + \ in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.common.LayerProtocolName: + type: "string" + enum: + - "ODU" + - "ETH" + - "DSR" + - "PHOTONIC_MEDIA" + tapi.common.LifecycleState: + type: "string" + enum: + - "PLANNED" + - "POTENTIAL_AVAILABLE" + - "POTENTIAL_BUSY" + - "INSTALLED" + - "PENDING_REMOVAL" + tapi.common.LocalClass: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + local-id: + type: "string" + description: "none" + tapi.common.NameAndValue: + type: "object" + properties: + value-name: + type: "string" + description: "The name of the value. The value need not have a name." + value: + type: "string" + description: "The value" + tapi.common.OperationalState: + type: "string" + enum: + - "DISABLED" + - "ENABLED" + tapi.common.PortDirection: + type: "string" + enum: + - "BIDIRECTIONAL" + - "INPUT" + - "OUTPUT" + - "UNIDENTIFIED_OR_UNKNOWN" + tapi.common.PortRole: + type: "string" + enum: + - "SYMMETRIC" + - "ROOT" + - "LEAF" + - "TRUNK" + - "UNKNOWN" + tapi.common.ServiceInterfacePoint: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + supported-layer-protocol-qualifier: + type: "array" + description: "none" + items: + type: "string" + layer-protocol-name: + description: "Usage of layerProtocolName [>1] in the ServiceInterfacePoint\ + \ should be considered experimental" + $ref: "#/definitions/tapi.common.LayerProtocolName" + description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ + \ termination and adaptation functions of one or more transport layers. \r\ + \n The structure of LTP supports all transport protocols including\ + \ circuit and packet forms." + tapi.common.ServiceInterfacePointRef: + type: "object" + properties: + service-interface-point-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-common:service-interface-point/tapi-common:uuid" + tapi.common.TapiContext: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + service-interface-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + description: "The Network Control Domain (NCD) object class represents the scope\ + \ of control that a particular SDN controller has with respect to a particular\ + \ network, (i.e., encompassing a designated set of interconnected (virtual)\ + \ network elements)." + tapi.common.TerminationDirection: + type: "string" + enum: + - "BIDIRECTIONAL" + - "SINK" + - "SOURCE" + - "UNDEFINED_OR_UNKNOWN" + tapi.common.TerminationPac: + type: "object" + properties: + termination-direction: + description: "The overall directionality of the LP. \r\n -\ + \ A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ + \ - A SINK LP can only contain elements with SINK flows or CONTRA_DIRECTION_SOURCE\ + \ flows\r\n - A SOURCE LP can only contain SOURCE flows or\ + \ CONTRA_DIRECTION_SINK flows" + $ref: "#/definitions/tapi.common.TerminationDirection" + termination-state: + description: "Indicates whether the layer is terminated and if so how." + $ref: "#/definitions/tapi.common.TerminationState" + tapi.common.TerminationState: + type: "string" + enum: + - "LP_CAN_NEVER_TERMINATE" + - "LT_NOT_TERMINATED" + - "TERMINATED_SERVER_TO_CLIENT_FLOW" + - "TERMINATED_CLIENT_TO_SERVER_FLOW" + - "TERMINATED_BIDIRECTIONAL" + - "LT_PERMENANTLY_TERMINATED" + - "TERMINATION_STATE_UNKNOWN" + tapi.common.TimeRange: + type: "object" + properties: + end-time: + type: "string" + description: "none" + start-time: + type: "string" + description: "none" + tapi.common.getserviceinterfacepointdetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.common.getserviceinterfacepointdetails.Output: + type: "object" + properties: + sip: + description: "none" + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + tapi.common.getserviceinterfacepointlist.Output: + type: "object" + properties: + sip: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + tapi.common.updateserviceinterfacepoint.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + tapi.notification.ContextAugmentation1: + type: "object" + properties: + notification-context: + description: "Augments the base TAPI Context with NotificationService information" + $ref: "#/definitions/tapi.notification.NotificationContext" + x-augmentation: + prefix: "tapi-notification" + namespace: "urn:onf:otcc:yang:tapi-notification" + tapi.notification.CreateNotificationSubscriptionService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Output" + tapi.notification.GetNotificationList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationlist.Output" + tapi.notification.GetNotificationSubscriptionServiceDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Output" + tapi.notification.GetNotificationSubscriptionServiceList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicelist.Output" + tapi.notification.GetSupportedNotificationTypes: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getsupportednotificationtypes.Output" + tapi.notification.NameAndValueChange: + type: "object" + properties: + value-name: + type: "string" + description: "The name of the value. The value need not have a name." + old-value: + type: "string" + description: "The value" + new-value: + type: "string" + description: "The value" + tapi.notification.Notification: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + target-object-type: + type: "string" + description: "none" + additional-text: + type: "string" + description: "none" + event-time-stamp: + type: "string" + description: "none" + additional-info: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.NameAndValue" + sequence-number: + type: "integer" + format: "int32" + description: "A monotonous increasing sequence number associated with the\ + \ notification.\r\n The exact semantics of how this sequence\ + \ number is assigned (per channel or subscription or source or system)\ + \ is left undefined." + target-object-identifier: + type: "string" + description: "none" + notification-type: + type: "string" + description: "none" + target-object-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.NameAndValue" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + source-indicator: + description: "none" + $ref: "#/definitions/tapi.notification.SourceIndicator" + layer-protocol-qualifier: + type: "string" + description: "none" + changed-attributes: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + description: "none" + tapi.notification.NotificationChannel: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + next-sequence-no: + type: "integer" + format: "int32" + description: "The sequence number of the next notification that will be\ + \ published on the channel" + stream-address: + type: "string" + description: "The address/location/URI of the channel/stream to which the\ + \ subscribed notifications are published.\r\n This specifics\ + \ of this is typically dependent on the implementation protocol & mechanism\ + \ and hence is typed as a string." + description: "none" + tapi.notification.NotificationContext: + type: "object" + properties: + notif-subscription: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.Notification" + tapi.notification.NotificationSubscriptionService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.Notification" + notification-channel: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationChannel" + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + supported-object-types: + type: "array" + description: "none" + items: + type: "string" + supported-notification-types: + type: "array" + description: "none" + items: + type: "string" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + description: "none" + tapi.notification.SourceIndicator: + type: "string" + enum: + - "RESOURCE_OPERATION" + - "MANAGEMENT_OPERATION" + - "UNKNOWN" + tapi.notification.SubscriptionFilter: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + requested-notification-types: + type: "array" + description: "none" + items: + type: "string" + requested-object-identifier: + type: "array" + description: "none" + items: + type: "string" + requested-layer-protocols: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + include-content: + type: "boolean" + description: "Indicates whether the published Notification includes content\ + \ or just the Notification Id (which enables retrieval of the notification\ + \ at the later stage)" + default: false + requested-object-types: + type: "array" + description: "none" + items: + type: "string" + description: "none" + tapi.notification.SubscriptionState: + type: "string" + enum: + - "SUSPENDED" + - "ACTIVE" + tapi.notification.UpdateNotificationSubscriptionService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Output" + tapi.notification.createnotificationsubscriptionservice.Input: + type: "object" + properties: + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + tapi.notification.createnotificationsubscriptionservice.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.deletenotificationsubscriptionservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationlist.Input: + type: "object" + properties: + time-range: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + subscription-id: + type: "string" + description: "UUID of the associated Notification Subscription Service: An\ + \ identifier that is universally unique within an identifier space, where\ + \ the identifier space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationlist.Output: + type: "object" + properties: + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.Notification" + tapi.notification.getnotificationsubscriptionservicedetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationsubscriptionservicedetails.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.getnotificationsubscriptionservicelist.Output: + type: "object" + properties: + subscription-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.getsupportednotificationtypes.Output: + type: "object" + properties: + supported-object-types: + type: "array" + description: "none" + items: + type: "string" + supported-notification-types: + type: "array" + description: "none" + items: + type: "string" + tapi.notification.updatenotificationsubscriptionservice.Input: + type: "object" + properties: + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + tapi.notification.updatenotificationsubscriptionservice.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.topology.ContextAugmentation2: + type: "object" + properties: + topology-context: + description: "Augments the base TAPI Context with TopologyService information" + $ref: "#/definitions/tapi.topology.TopologyContext" + x-augmentation: + prefix: "tapi-topology" + namespace: "urn:onf:otcc:yang:tapi-topology" + tapi.topology.CostCharacteristic: + type: "object" + properties: + cost-value: + type: "string" + description: "The specific cost." + cost-algorithm: + type: "string" + description: "The cost may vary based upon some properties of the TopologicalEntity.\ + \ The rules for the variation are conveyed by the costAlgorithm." + cost-name: + type: "string" + description: "The cost characteristic will related to some aspect of the TopologicalEntity\ + \ (e.g. $ cost, routing weight). This aspect will be conveyed by the costName." + tapi.topology.ForwardingRule: + type: "string" + enum: + - "MAY_FORWARD_ACROSS_GROUP" + - "MUST_FORWARD_ACROSS_GROUP" + - "CANNOT_FORWARD_ACROSS_GROUP" + - "NO_STATEMENT_ON_FORWARDING" + tapi.topology.GetLinkDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getlinkdetails.Output" + tapi.topology.GetNodeDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getnodedetails.Output" + tapi.topology.GetNodeEdgePointDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Output" + tapi.topology.GetTopologyDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.gettopologydetails.Output" + tapi.topology.GetTopologyList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.gettopologylist.Output" + tapi.topology.InterRuleGroup: + allOf: + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + associated-node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + rule: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Rule" + description: "none" + tapi.topology.LatencyCharacteristic: + type: "object" + properties: + traffic-property-name: + type: "string" + description: "The identifier of the specific traffic property to which the\ + \ queuing latency applies." + jitter-characteristic: + type: "string" + description: "High frequency deviation from true periodicity of a signal and\ + \ therefore a small high rate of change of transfer latency.\r\n \ + \ Applies to TDM systems (and not packet)." + fixed-latency-characteristic: + type: "string" + description: "A TopologicalEntity suffers delay caused by the realization\ + \ of the servers (e.g. distance related; FEC encoding etc.) along with some\ + \ client specific processing. This is the total average latency effect of\ + \ the TopologicalEntity" + wander-characteristic: + type: "string" + description: "Low frequency deviation from true periodicity of a signal and\ + \ therefore a small low rate of change of transfer latency.\r\n \ + \ Applies to TDM systems (and not packet)." + queing-latency-characteristic: + type: "string" + description: "The specific queuing latency for the traffic property." + tapi.topology.LayerProtocolTransitionPac: + type: "object" + properties: + transitioned-layer-protocol-name: + type: "array" + description: "Provides the ordered structure of layer protocol transitions\ + \ encapsulated in the TopologicalEntity. The ordering relates to the LinkPort\ + \ role." + items: + type: "string" + tapi.topology.Link: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.LayerProtocolTransitionPac" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - $ref: "#/definitions/tapi.topology.ValidationPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + restoration-policy: + description: "none" + $ref: "#/definitions/tapi.topology.RestorationPolicy" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" + direction: + description: "The directionality of the Link. \r\n Is applicable\ + \ to simple Links where all LinkEnds are BIDIRECTIONAL (the Link will\ + \ be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ + \ \r\n Is not present in more complex cases." + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "The Link object class models effective adjacency between two or\ + \ more ForwardingDomains (FD). " + tapi.topology.NepLayerProtocolCapability: + type: "object" + properties: + layer-protocol-qualifier: + type: "string" + description: "none" + number-of-cep-instances: + type: "integer" + format: "int32" + description: "none" + tapi.topology.NetworkTopologyService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.TopologyRef" + description: "none" + tapi.topology.Node: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + encap-topology: + description: "none" + $ref: "#/definitions/tapi.topology.TopologyRef" + node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePoint" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ + \ topological component which is used to effect forwarding of transport characteristic\ + \ information and offers the potential to enable forwarding. \r\n \ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ multiple switch matrices (FDs). " + tapi.topology.NodeEdgePoint: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.common.TerminationPac" + - type: "object" + properties: + link-port-role: + description: "Each LinkEnd of the Link has a role (e.g., symmetric, hub,\ + \ spoke, leaf, root) in the context of the Link with respect to the Link\ + \ function. " + $ref: "#/definitions/tapi.common.PortRole" + mapped-service-interface-point: + type: "array" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load\ + \ balancing/Resilience) should be considered experimental" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + available-cep-layer-protocol: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + link-port-direction: + description: "The orientation of defined flow at the LinkEnd." + $ref: "#/definitions/tapi.common.PortDirection" + description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ + \ termination and adaptation functions of one or more transport layers. \r\ + \n The structure of LTP supports all transport protocols including\ + \ circuit and packet forms." + tapi.topology.NodeEdgePointRef: + allOf: + - $ref: "#/definitions/tapi.topology.NodeRef" + - type: "object" + properties: + node-edge-point-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-edge-point/tapi-topology:uuid" + description: "none" + tapi.topology.NodeRef: + allOf: + - $ref: "#/definitions/tapi.topology.TopologyRef" + - type: "object" + properties: + node-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:uuid" + description: "none" + tapi.topology.NodeRuleGroup: + allOf: + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + inter-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.InterRuleGroup" + rule: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Rule" + composed-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "none" + tapi.topology.NodeRuleGroupRef: + allOf: + - $ref: "#/definitions/tapi.topology.NodeRef" + - type: "object" + properties: + node-rule-group-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-rule-group/tapi-topology:uuid" + description: "none" + tapi.topology.ProtectionType: + type: "string" + enum: + - "NO_PROTECTION" + - "ONE_PLUS_ONE_PROTECTION" + - "ONE_FOR_ONE_PROTECTION" + - "ONE_FOR_N_PROTECTION" + - "M_FOR_N_PROTECTION" + - "ONE_FOR_ONE_BY_N" + tapi.topology.RestorationPolicy: + type: "string" + enum: + - "PER_DOMAIN_RESTORATION" + - "END_TO_END_RESTORATION" + - "NA" + - "DYNAMIC_RESTORATION" + - "PRE_COMPUTED_RESTORATION" + tapi.topology.RiskCharacteristic: + type: "object" + properties: + risk-characteristic-name: + type: "string" + description: "The name of the risk characteristic. The characteristic may\ + \ be related to a specific degree of closeness. \r\n For\ + \ example a particular characteristic may apply to failures that are localized\ + \ (e.g. to one side of a road) where as another characteristic may relate\ + \ to failures that have a broader impact (e.g. both sides of a road that\ + \ crosses a bridge).\r\n Depending upon the importance of\ + \ the traffic being routed different risk characteristics will be evaluated." + risk-identifier-list: + type: "array" + description: "A list of the identifiers of each physical/geographic unit (with\ + \ the specific risk characteristic) that is related to a segment of the\ + \ TopologicalEntity." + items: + type: "string" + tapi.topology.RiskParameterPac: + type: "object" + properties: + risk-characteristic: + type: "array" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + items: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + tapi.topology.Rule: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + override-priority: + type: "integer" + format: "int32" + description: "none" + forwarding-rule: + description: "none" + $ref: "#/definitions/tapi.topology.ForwardingRule" + rule-type: + description: "none" + $ref: "#/definitions/tapi.topology.RuleType" + description: "none" + tapi.topology.RuleType: + type: "string" + enum: + - "FORWARDING" + - "CAPACITY" + - "COST" + - "TIMING" + - "RISK" + - "GROUPING" + tapi.topology.Topology: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + link: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Link" + node: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Node" + boundary-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ + \ topological component which is used to effect forwarding of transport characteristic\ + \ information and offers the potential to enable forwarding. \r\n \ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ multiple switch matrices (FDs). " + tapi.topology.TopologyContext: + type: "object" + properties: + nw-topology-service: + description: "none" + $ref: "#/definitions/tapi.topology.NetworkTopologyService" + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.TopologyRef: + type: "object" + properties: + topology-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:uuid" + tapi.topology.TransferCostPac: + type: "object" + properties: + cost-characteristic: + type: "array" + description: "The list of costs where each cost relates to some aspect of\ + \ the TopologicalEntity." + items: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + tapi.topology.TransferIntegrityPac: + type: "object" + properties: + error-characteristic: + type: "string" + description: "Describes the degree to which the signal propagated can be errored.\ + \ \r\n Applies to TDM systems as the errored signal will\ + \ be propagated and not packet as errored packets will be discarded." + unavailable-time-characteristic: + type: "string" + description: "Describes the duration for which there may be no valid signal\ + \ propagated." + server-integrity-process-characteristic: + type: "string" + description: "Describes the effect of any server integrity enhancement process\ + \ on the characteristics of the TopologicalEntity." + delivery-order-characteristic: + type: "string" + description: "Describes the degree to which packets will be delivered out\ + \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ + \ maintain strict order." + repeat-delivery-characteristic: + type: "string" + description: "Primarily applies to packet systems where a packet may be delivered\ + \ more than once (in fault recovery for example). \r\n It\ + \ can also apply to TDM where several frames may be received twice due to\ + \ switching in a system with a large differential propagation delay." + loss-characteristic: + type: "string" + description: "Describes the acceptable characteristic of lost packets where\ + \ loss may result from discard due to errors or overflow.\r\n \ + \ Applies to packet systems and not TDM (as for TDM errored signals\ + \ are propagated unless grossly errored and overflow/underflow turns into\ + \ timing slips)." + tapi.topology.TransferTimingPac: + type: "object" + properties: + latency-characteristic: + type: "array" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + items: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + tapi.topology.ValidationMechanism: + type: "object" + properties: + layer-protocol-adjacency-validated: + type: "string" + description: "State of validatiion" + validation-mechanism: + type: "string" + description: "Name of mechanism used to validate adjacency" + validation-robustness: + type: "string" + description: "Quality of validation (i.e. how likely is the stated validation\ + \ to be invalid)" + tapi.topology.ValidationPac: + type: "object" + properties: + validation-mechanism: + type: "array" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." + items: + $ref: "#/definitions/tapi.topology.ValidationMechanism" + tapi.topology.getlinkdetails.Input: + type: "object" + properties: + link-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getlinkdetails.Output: + type: "object" + properties: + link: + description: "none" + $ref: "#/definitions/tapi.topology.Link" + tapi.topology.getnodedetails.Input: + type: "object" + properties: + node-id: + type: "string" + description: "UUID of the Node: An identifier that is universally unique within\ + \ an identifier space, where the identifier space is itself globally unique,\ + \ and immutable.\r\n An UUID carries no semantics with\ + \ respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The canonical\ + \ representation uses lowercase characters.\r\n Pattern:\ + \ [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getnodedetails.Output: + type: "object" + properties: + node: + description: "none" + $ref: "#/definitions/tapi.topology.Node" + tapi.topology.getnodeedgepointdetails.Input: + type: "object" + properties: + node-id: + type: "string" + description: "UUID of the parent Node: An identifier that is universally unique\ + \ within an identifier space, where the identifier space is itself globally\ + \ unique, and immutable.\r\n An UUID carries no semantics\ + \ with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The\ + \ canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Node's Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + node-edge-point-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getnodeedgepointdetails.Output: + type: "object" + properties: + node-edge-point: + description: "none" + $ref: "#/definitions/tapi.topology.NodeEdgePoint" + tapi.topology.gettopologydetails.Input: + type: "object" + properties: + topology-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.gettopologydetails.Output: + type: "object" + properties: + topology: + description: "none" + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.gettopologylist.Output: + type: "object" + properties: + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Topology" diff --git a/OAS/tapi-virtual-network@2019-03-31.yaml b/OAS/tapi-virtual-network@2019-03-31.yaml new file mode 100644 index 00000000..708c2c09 --- /dev/null +++ b/OAS/tapi-virtual-network@2019-03-31.yaml @@ -0,0 +1,6559 @@ +--- +swagger: "2.0" +info: + description: "\r\n This module contains TAPI Virtual Network Model definitions.\r\ + \n Source: TapiVirtualNetwork.uml\r\n Copyright (c) 2018 Open Networking\ + \ Foundation (ONF). All rights reserved.\r\n License: This module is distributed\ + \ under the Apache License 2.0\r\n - The TAPI YANG models included in this\ + \ TAPI release are a *normative* part of the TAPI SDK.\r\n - The YANG specifications\ + \ have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG\ + \ mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Notification\ + \ Model definitions.\r\n Source: TapiNotification.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Topology\ + \ Model definitions.\r\n Source: TapiTopology.uml\r\n Copyright\ + \ (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r\n License:\ + \ This module is distributed under the Apache License 2.0\r\n - The TAPI\ + \ YANG models included in this TAPI release are a *normative* part of the TAPI\ + \ SDK.\r\n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases.,\r\n This module contains TAPI Common Model\ + \ definitions.\r\n Source: TapiCommon.uml\r\n Copyright (c) 2018\ + \ Open Networking Foundation (ONF). All rights reserved.\r\n License: This\ + \ module is distributed under the Apache License 2.0\r\n - The TAPI YANG\ + \ models included in this TAPI release are a *normative* part of the TAPI SDK.\r\ + \n - The YANG specifications have been generated from the corresponding\ + \ UML model using the [ONF EAGLE UML2YANG mapping tool]\r\n \r\ + \n and further edited manually to comply with the [ONF IISOMI UML2YANG\ + \ mapping guidelines]\r\n \r\ + \n - Status of YANG model artifacts can be determined by referring to the\ + \ corresponding UML artifacts.\r\n As described in the UML models, some\ + \ artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r\ + \n - The ONF TAPI release process does not guarantee backward compatibility\ + \ of YANG models across major versions of TAPI releases.\r\n The YANG model\ + \ backward compatibility criteria are outlined in section 11 of .\r\ + \n YANG models included in this release may not be backward compatible\ + \ with previous TAPI releases." + version: "2.2.0" + title: "tapi-virtual-network,tapi-notification,tapi-topology,tapi-common API" +host: "localhost:1234" +consumes: +- "application/yang-data+json" +produces: +- "application/yang-data+json" +paths: + /data/context/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Context" + description: "none" + parameters: [] + responses: + 200: + description: "tapi.common.Context" + schema: + $ref: "#/definitions/tapi.common.Context" + 400: + description: "Internal error" + post: + tags: + - "tapi-common" + summary: "creates tapi.common.Context" + description: "none" + parameters: + - in: "body" + name: "tapi.common.Context.body-param" + description: "tapi.common.Context to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.Context" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.Context" + description: "none" + parameters: + - in: "body" + name: "tapi.common.Context.body-param" + description: "tapi.common.Context to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.Context" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.Context" + description: "none" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/name/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] + responses: + 200: + description: "tapi.notification.NotificationContext" + schema: + $ref: "#/definitions/tapi.notification.NotificationContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: + - in: "body" + name: "tapi.notification.NotificationContext.body-param" + description: "tapi.notification.NotificationContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: + - in: "body" + name: "tapi.notification.NotificationContext.body-param" + description: "tapi.notification.NotificationContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.NotificationContext" + description: "Augments the base TAPI Context with NotificationService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - in: "body" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NotificationSubscriptionService" + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.NotificationSubscriptionService.body-param" + description: "tapi.notification.NotificationSubscriptionService to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.NotificationSubscriptionService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/name/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/notification-channel/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NotificationChannel" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NotificationChannel" + schema: + $ref: "#/definitions/tapi.notification.NotificationChannel" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification-channel/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.Notification" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.Notification" + schema: + $ref: "#/definitions/tapi.notification.Notification" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/additional-info={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/changed-attributes={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/notification={notification-uuid}/target-object-name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "notification-uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.SubscriptionFilter" + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + 400: + description: "Internal error" + post: + tags: + - "tapi-notification" + summary: "creates tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.notification.SubscriptionFilter.body-param" + description: "tapi.notification.SubscriptionFilter to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.notification.SubscriptionFilter" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name/: + post: + tags: + - "tapi-notification" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/notification-context/notif-subscription={uuid}/subscription-filter/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-notification" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-notification" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notif-subscription" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/notification-context/notification={uuid}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.Notification" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.Notification" + schema: + $ref: "#/definitions/tapi.notification.Notification" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/additional-info={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of additional-info" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/changed-attributes={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.notification.NameAndValueChange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of changed-attributes" + required: true + type: "string" + responses: + 200: + description: "tapi.notification.NameAndValueChange" + schema: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/notification-context/notification={uuid}/target-object-name={value-name}/: + get: + tags: + - "tapi-notification" + summary: "returns tapi.common.NameAndValue" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of notification" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of target-object-name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/service-interface-point/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - in: "body" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/service-interface-point={uuid}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePoint" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.ServiceInterfacePoint.body-param" + description: "tapi.common.ServiceInterfacePoint to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.ServiceInterfacePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/available-capacity/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/name/: + post: + tags: + - "tapi-common" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/service-interface-point={uuid}/name={value-name}/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-common" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-common" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/service-interface-point={uuid}/total-potential-capacity/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/service-interface-point={uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-common" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] + responses: + 200: + description: "tapi.topology.TopologyContext" + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-topology" + summary: "creates tapi.topology.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: + - in: "body" + name: "tapi.topology.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-topology" + summary: "creates or updates tapi.topology.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: + - in: "body" + name: "tapi.topology.TopologyContext.body-param" + description: "tapi.topology.TopologyContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.topology.TopologyContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-topology" + summary: "removes tapi.topology.TopologyContext" + description: "Augments the base TAPI Context with TopologyService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/topology-context/nw-topology-service/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NetworkTopologyService" + description: "none" + parameters: [] + responses: + 200: + description: "tapi.topology.NetworkTopologyService" + schema: + $ref: "#/definitions/tapi.topology.NetworkTopologyService" + 400: + description: "Internal error" + /data/context/topology-context/nw-topology-service/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/nw-topology-service/topology={topology-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.TopologyRef" + description: "none" + parameters: + - name: "topology-uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.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.Topology" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/boundary-node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of boundary-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Link" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Link" + schema: + $ref: "#/definitions/tapi.topology.Link" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/link={link-uuid}/node-edge-point={topology-uuid},{node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/risk-characteristic={risk-characteristic-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/link={link-uuid}/validation-mechanism={validation-mechanism}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.ValidationMechanism" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "link-uuid" + in: "path" + description: "Id of link" + required: true + type: "string" + - name: "validation-mechanism" + in: "path" + description: "Id of validation-mechanism" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.ValidationMechanism" + schema: + $ref: "#/definitions/tapi.topology.ValidationMechanism" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.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.Node" + schema: + $ref: "#/definitions/tapi.topology.Node" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/available-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/encap-topology/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.TopologyRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/latency-characteristic={traffic-property-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePoint" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePoint" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/aggregated-node-edge-point={topology-uuid},{aggregated-node-edge-point-node-uuid},{aggregated-node-edge-point-node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + - name: "aggregated-node-edge-point-node-edge-point-uuid" + in: "path" + description: "Id of aggregated-node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/available-cep-layer-protocol={layer-protocol-qualifier}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NepLayerProtocolCapability" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "layer-protocol-qualifier" + in: "path" + description: "Id of available-cep-layer-protocol" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NepLayerProtocolCapability" + schema: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/mapped-service-interface-point={service-interface-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load balancing/Resilience)\ + \ should be considered experimental" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "service-interface-point-uuid" + in: "path" + description: "Id of mapped-service-interface-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePointRef" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-edge-point={node-edge-point-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroup" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroup" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/composed-rule-group={topology-uuid},{composed-rule-group-node-uuid},{composed-rule-group-node-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + - name: "composed-rule-group-node-rule-group-uuid" + in: "path" + description: "Id of composed-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroupRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/cost-characteristic={cost-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.InterRuleGroup" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.InterRuleGroup" + schema: + $ref: "#/definitions/tapi.topology.InterRuleGroup" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/associated-node-rule-group={topology-uuid},{associated-node-rule-group-node-uuid},{associated-node-rule-group-node-rule-group-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeRuleGroupRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + - name: "associated-node-rule-group-node-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + - name: "associated-node-rule-group-node-rule-group-uuid" + in: "path" + description: "Id of associated-node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeRuleGroupRef" + schema: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "Capacity available to be assigned." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/available-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/cost-characteristic={cost-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.CostCharacteristic" + description: "The list of costs where each cost relates to some aspect of the\ + \ TopologicalEntity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Rule" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Rule" + schema: + $ref: "#/definitions/tapi.topology.Rule" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/rule={local-id}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "inter-rule-group-uuid" + in: "path" + description: "Id of inter-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/name={value-name}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/node-edge-point={topology-uuid},{node-edge-point-node-uuid},{node-edge-point-uuid}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.NodeEdgePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "topology-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-node-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + - name: "node-edge-point-uuid" + in: "path" + description: "Id of node-edge-point" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.NodeEdgePointRef" + schema: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/risk-characteristic={risk-characteristic-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.RiskCharacteristic" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "risk-characteristic-name" + in: "path" + description: "Id of risk-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.RiskCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.topology.Rule" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.Rule" + schema: + $ref: "#/definitions/tapi.topology.Rule" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/rule={local-id}/name={value-name}/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of rule" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + ? /data/context/topology-context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/total-potential-capacity/total-size/ + : get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + - name: "node-rule-group-uuid" + in: "path" + description: "Id of node-rule-group" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.Capacity" + description: "An optimistic view of the capacity of the TopologicalEntity assuming\ + \ that any shared capacity is available to be taken." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + /data/context/topology-context/topology={uuid}/node={node-uuid}/total-potential-capacity/total-size/: + get: + tags: + - "tapi-topology" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of topology" + required: true + type: "string" + - name: "node-uuid" + in: "path" + description: "Id of node" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + /data/context/virtual-network-context/: + get: + tags: + - "tapi-virtual-network" + summary: "returns tapi.virtual.network.VirtualNetworkContext" + description: "Augments the base TAPI Context with VirtualNetworkService information" + parameters: [] + responses: + 200: + description: "tapi.virtual.network.VirtualNetworkContext" + schema: + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkContext" + 400: + description: "Internal error" + post: + tags: + - "tapi-virtual-network" + summary: "creates tapi.virtual.network.VirtualNetworkContext" + description: "Augments the base TAPI Context with VirtualNetworkService information" + parameters: + - in: "body" + name: "tapi.virtual.network.VirtualNetworkContext.body-param" + description: "tapi.virtual.network.VirtualNetworkContext to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-virtual-network" + summary: "creates or updates tapi.virtual.network.VirtualNetworkContext" + description: "Augments the base TAPI Context with VirtualNetworkService information" + parameters: + - in: "body" + name: "tapi.virtual.network.VirtualNetworkContext.body-param" + description: "tapi.virtual.network.VirtualNetworkContext to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkContext" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-virtual-network" + summary: "removes tapi.virtual.network.VirtualNetworkContext" + description: "Augments the base TAPI Context with VirtualNetworkService information" + parameters: [] + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/virtual-network-context/virtual-nw-service/: + post: + tags: + - "tapi-virtual-network" + summary: "creates tapi.virtual.network.VirtualNetworkService" + description: "none" + parameters: + - in: "body" + name: "tapi.virtual.network.VirtualNetworkService.body-param" + description: "tapi.virtual.network.VirtualNetworkService to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/virtual-network-context/virtual-nw-service={uuid}/: + get: + tags: + - "tapi-virtual-network" + summary: "returns tapi.virtual.network.VirtualNetworkService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + responses: + 200: + description: "tapi.virtual.network.VirtualNetworkService" + schema: + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkService" + 400: + description: "Internal error" + put: + tags: + - "tapi-virtual-network" + summary: "creates or updates tapi.virtual.network.VirtualNetworkService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - in: "body" + name: "tapi.virtual.network.VirtualNetworkService.body-param" + description: "tapi.virtual.network.VirtualNetworkService to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkService" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-virtual-network" + summary: "removes tapi.virtual.network.VirtualNetworkService" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/virtual-network-context/virtual-nw-service={uuid}/end-point/: + post: + tags: + - "tapi-virtual-network" + summary: "creates tapi.virtual.network.VirtualNetworkServiceEndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - in: "body" + name: "tapi.virtual.network.VirtualNetworkServiceEndPoint.body-param" + description: "tapi.virtual.network.VirtualNetworkServiceEndPoint to be added\ + \ to list" + required: false + schema: + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkServiceEndPoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/virtual-network-context/virtual-nw-service={uuid}/end-point={local-id}/: + get: + tags: + - "tapi-virtual-network" + summary: "returns tapi.virtual.network.VirtualNetworkServiceEndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.virtual.network.VirtualNetworkServiceEndPoint" + schema: + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkServiceEndPoint" + 400: + description: "Internal error" + put: + tags: + - "tapi-virtual-network" + summary: "creates or updates tapi.virtual.network.VirtualNetworkServiceEndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.virtual.network.VirtualNetworkServiceEndPoint.body-param" + description: "tapi.virtual.network.VirtualNetworkServiceEndPoint to be added\ + \ or updated" + required: false + schema: + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkServiceEndPoint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-virtual-network" + summary: "removes tapi.virtual.network.VirtualNetworkServiceEndPoint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/virtual-network-context/virtual-nw-service={uuid}/end-point={local-id}/name/: + post: + tags: + - "tapi-virtual-network" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/virtual-network-context/virtual-nw-service={uuid}/end-point={local-id}/name={value-name}/: + get: + tags: + - "tapi-virtual-network" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-virtual-network" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-virtual-network" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/virtual-network-context/virtual-nw-service={uuid}/end-point={local-id}/service-interface-point/: + get: + tags: + - "tapi-virtual-network" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of end-point" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePointRef" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 400: + description: "Internal error" + /data/context/virtual-network-context/virtual-nw-service={uuid}/name/: + post: + tags: + - "tapi-virtual-network" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/virtual-network-context/virtual-nw-service={uuid}/name={value-name}/: + get: + tags: + - "tapi-virtual-network" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-virtual-network" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-virtual-network" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/virtual-network-context/virtual-nw-service={uuid}/schedule/: + get: + tags: + - "tapi-virtual-network" + summary: "returns tapi.common.TimeRange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + responses: + 200: + description: "tapi.common.TimeRange" + schema: + $ref: "#/definitions/tapi.common.TimeRange" + 400: + description: "Internal error" + post: + tags: + - "tapi-virtual-network" + summary: "creates tapi.common.TimeRange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.TimeRange" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-virtual-network" + summary: "creates or updates tapi.common.TimeRange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.TimeRange.body-param" + description: "tapi.common.TimeRange to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.TimeRange" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-virtual-network" + summary: "removes tapi.common.TimeRange" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/virtual-network-context/virtual-nw-service={uuid}/state/: + get: + tags: + - "tapi-virtual-network" + summary: "returns tapi.common.AdminStatePac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + responses: + 200: + description: "tapi.common.AdminStatePac" + schema: + $ref: "#/definitions/tapi.common.AdminStatePac" + 400: + description: "Internal error" + post: + tags: + - "tapi-virtual-network" + summary: "creates tapi.common.AdminStatePac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.AdminStatePac.body-param" + description: "tapi.common.AdminStatePac to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.AdminStatePac" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-virtual-network" + summary: "creates or updates tapi.common.AdminStatePac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - in: "body" + name: "tapi.common.AdminStatePac.body-param" + description: "tapi.common.AdminStatePac to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.AdminStatePac" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-virtual-network" + summary: "removes tapi.common.AdminStatePac" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/virtual-network-context/virtual-nw-service={uuid}/topology/: + get: + tags: + - "tapi-virtual-network" + summary: "returns tapi.topology.TopologyRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.TopologyRef" + schema: + $ref: "#/definitions/tapi.topology.TopologyRef" + 400: + description: "Internal error" + /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint/: + post: + tags: + - "tapi-virtual-network" + summary: "creates tapi.virtual.network.VirtualNetworkConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - in: "body" + name: "tapi.virtual.network.VirtualNetworkConstraint.body-param" + description: "tapi.virtual.network.VirtualNetworkConstraint to be added to\ + \ list" + required: false + schema: + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/: + get: + tags: + - "tapi-virtual-network" + summary: "returns tapi.virtual.network.VirtualNetworkConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of vnw-constraint" + required: true + type: "string" + responses: + 200: + description: "tapi.virtual.network.VirtualNetworkConstraint" + schema: + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkConstraint" + 400: + description: "Internal error" + put: + tags: + - "tapi-virtual-network" + summary: "creates or updates tapi.virtual.network.VirtualNetworkConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of vnw-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.virtual.network.VirtualNetworkConstraint.body-param" + description: "tapi.virtual.network.VirtualNetworkConstraint to be added or\ + \ updated" + required: false + schema: + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkConstraint" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-virtual-network" + summary: "removes tapi.virtual.network.VirtualNetworkConstraint" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of vnw-constraint" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/cost-characteristic/: + post: + tags: + - "tapi-virtual-network" + 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 virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of vnw-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/cost-characteristic={cost-name}/: + get: + tags: + - "tapi-virtual-network" + 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 virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of vnw-constraint" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.CostCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + 400: + description: "Internal error" + put: + tags: + - "tapi-virtual-network" + 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 virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of vnw-constraint" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + - in: "body" + name: "tapi.topology.CostCharacteristic.body-param" + description: "tapi.topology.CostCharacteristic to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-virtual-network" + 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 virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of vnw-constraint" + required: true + type: "string" + - name: "cost-name" + in: "path" + description: "Id of cost-characteristic" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + ? /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/diversity-exclusion={virtual-nw-service-uuid}/ + : get: + tags: + - "tapi-virtual-network" + summary: "returns tapi.virtual.network.VirtualNwServiceRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of vnw-constraint" + required: true + type: "string" + - name: "virtual-nw-service-uuid" + in: "path" + description: "Id of diversity-exclusion" + required: true + type: "string" + responses: + 200: + description: "tapi.virtual.network.VirtualNwServiceRef" + schema: + $ref: "#/definitions/tapi.virtual.network.VirtualNwServiceRef" + 400: + description: "Internal error" + /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/latency-characteristic/: + post: + tags: + - "tapi-virtual-network" + 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 virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of vnw-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.topology.LatencyCharacteristic.body-param" + description: "tapi.topology.LatencyCharacteristic to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + ? /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/latency-characteristic={traffic-property-name}/ + : get: + tags: + - "tapi-virtual-network" + summary: "returns tapi.topology.LatencyCharacteristic" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of vnw-constraint" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 200: + description: "tapi.topology.LatencyCharacteristic" + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + 400: + description: "Internal error" + put: + tags: + - "tapi-virtual-network" + 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 virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of vnw-constraint" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + - in: "body" + name: "tapi.topology.LatencyCharacteristic.body-param" + description: "tapi.topology.LatencyCharacteristic to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-virtual-network" + 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 virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of vnw-constraint" + required: true + type: "string" + - name: "traffic-property-name" + in: "path" + description: "Id of latency-characteristic" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/name/: + post: + tags: + - "tapi-virtual-network" + summary: "creates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of vnw-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/name={value-name}/: + get: + tags: + - "tapi-virtual-network" + summary: "returns tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of vnw-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 200: + description: "tapi.common.NameAndValue" + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + 400: + description: "Internal error" + put: + tags: + - "tapi-virtual-network" + summary: "creates or updates tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of vnw-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + - in: "body" + name: "tapi.common.NameAndValue.body-param" + description: "tapi.common.NameAndValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.NameAndValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-virtual-network" + summary: "removes tapi.common.NameAndValue" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of vnw-constraint" + required: true + type: "string" + - name: "value-name" + in: "path" + description: "Id of name" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/requested-capacity/: + get: + tags: + - "tapi-virtual-network" + summary: "returns tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of vnw-constraint" + required: true + type: "string" + responses: + 200: + description: "tapi.common.Capacity" + schema: + $ref: "#/definitions/tapi.common.Capacity" + 400: + description: "Internal error" + post: + tags: + - "tapi-virtual-network" + summary: "creates tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of vnw-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.Capacity" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-virtual-network" + summary: "creates or updates tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of vnw-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.common.Capacity.body-param" + description: "tapi.common.Capacity to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.Capacity" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-virtual-network" + summary: "removes tapi.common.Capacity" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of vnw-constraint" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/requested-capacity/total-size/: + get: + tags: + - "tapi-virtual-network" + summary: "returns tapi.common.CapacityValue" + description: "Total capacity of the TopologicalEntity in MB/s. In case of bandwidthProfile,\ + \ this is expected to same as the committedInformationRate." + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of vnw-constraint" + required: true + type: "string" + responses: + 200: + description: "tapi.common.CapacityValue" + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + 400: + description: "Internal error" + post: + tags: + - "tapi-virtual-network" + 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 virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of vnw-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added to list" + required: false + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 409: + description: "Object already exists" + put: + tags: + - "tapi-virtual-network" + 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 virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of vnw-constraint" + required: true + type: "string" + - in: "body" + name: "tapi.common.CapacityValue.body-param" + description: "tapi.common.CapacityValue to be added or updated" + required: false + schema: + $ref: "#/definitions/tapi.common.CapacityValue" + responses: + 201: + description: "Object created" + 400: + description: "Internal error" + 204: + description: "Object modified" + delete: + tags: + - "tapi-virtual-network" + 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 virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of vnw-constraint" + required: true + type: "string" + responses: + 400: + description: "Internal error" + 204: + description: "Object deleted" + /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/sink-service-end-point/: + get: + tags: + - "tapi-virtual-network" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of vnw-constraint" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePointRef" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 400: + description: "Internal error" + /data/context/virtual-network-context/virtual-nw-service={uuid}/vnw-constraint={local-id}/src-service-end-point/: + get: + tags: + - "tapi-virtual-network" + summary: "returns tapi.common.ServiceInterfacePointRef" + description: "none" + parameters: + - name: "uuid" + in: "path" + description: "Id of virtual-nw-service" + required: true + type: "string" + - name: "local-id" + in: "path" + description: "Id of vnw-constraint" + required: true + type: "string" + responses: + 200: + description: "tapi.common.ServiceInterfacePointRef" + schema: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 400: + description: "Internal error" + /operations/create-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.CreateNotificationSubscriptionService" + description: "operates on tapi.notification.CreateNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.createnotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.CreateNotificationSubscriptionService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/create-virtual-network-service/: + post: + tags: + - "tapi-virtual-network" + summary: "operates on tapi.virtual.network.CreateVirtualNetworkService" + description: "operates on tapi.virtual.network.CreateVirtualNetworkService" + parameters: + - in: "body" + name: "tapi.virtual.network.createvirtualnetworkservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.virtual.network.createvirtualnetworkservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.virtual.network.CreateVirtualNetworkService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.DeleteNotificationSubscriptionService" + description: "operates on tapi.notification.DeleteNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.deletenotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.deletenotificationsubscriptionservice.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" + /operations/delete-virtual-network-service/: + post: + tags: + - "tapi-virtual-network" + summary: "operates on tapi.virtual.network.DeleteVirtualNetworkService" + description: "operates on tapi.virtual.network.DeleteVirtualNetworkService" + parameters: + - in: "body" + name: "tapi.virtual.network.deletevirtualnetworkservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.virtual.network.deletevirtualnetworkservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.virtual.network.DeleteVirtualNetworkService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-link-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetLinkDetails" + description: "operates on tapi.topology.GetLinkDetails" + parameters: + - in: "body" + name: "tapi.topology.getlinkdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getlinkdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetLinkDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-node-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetNodeDetails" + description: "operates on tapi.topology.GetNodeDetails" + parameters: + - in: "body" + name: "tapi.topology.getnodedetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getnodedetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetNodeDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-node-edge-point-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetNodeEdgePointDetails" + description: "operates on tapi.topology.GetNodeEdgePointDetails" + parameters: + - in: "body" + name: "tapi.topology.getnodeedgepointdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetNodeEdgePointDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-list/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationList" + description: "operates on tapi.notification.GetNotificationList" + parameters: + - in: "body" + name: "tapi.notification.getnotificationlist.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.getnotificationlist.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-subscription-service-details/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + description: "operates on tapi.notification.GetNotificationSubscriptionServiceDetails" + parameters: + - in: "body" + name: "tapi.notification.getnotificationsubscriptionservicedetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-notification-subscription-service-list/: + post: + tags: + - "tapi-notification" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetNotificationSubscriptionServiceList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-service-interface-point-details/: + post: + tags: + - "tapi-common" + summary: "operates on tapi.common.GetServiceInterfacePointDetails" + description: "operates on tapi.common.GetServiceInterfacePointDetails" + parameters: + - in: "body" + name: "tapi.common.getserviceinterfacepointdetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.common.GetServiceInterfacePointDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-service-interface-point-list/: + post: + tags: + - "tapi-common" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.common.GetServiceInterfacePointList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-supported-notification-types/: + post: + tags: + - "tapi-notification" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.GetSupportedNotificationTypes" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-topology-details/: + post: + tags: + - "tapi-topology" + summary: "operates on tapi.topology.GetTopologyDetails" + description: "operates on tapi.topology.GetTopologyDetails" + parameters: + - in: "body" + name: "tapi.topology.gettopologydetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.topology.gettopologydetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetTopologyDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-topology-list/: + post: + tags: + - "tapi-topology" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.topology.GetTopologyList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-virtual-network-service-details/: + post: + tags: + - "tapi-virtual-network" + summary: "operates on tapi.virtual.network.GetVirtualNetworkServiceDetails" + description: "operates on tapi.virtual.network.GetVirtualNetworkServiceDetails" + parameters: + - in: "body" + name: "tapi.virtual.network.getvirtualnetworkservicedetails.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.virtual.network.getvirtualnetworkservicedetails.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.virtual.network.GetVirtualNetworkServiceDetails" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/get-virtual-network-service-list/: + post: + tags: + - "tapi-virtual-network" + parameters: [] + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.virtual.network.GetVirtualNetworkServiceList" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-notification-subscription-service/: + post: + tags: + - "tapi-notification" + summary: "operates on tapi.notification.UpdateNotificationSubscriptionService" + description: "operates on tapi.notification.UpdateNotificationSubscriptionService" + parameters: + - in: "body" + name: "tapi.notification.updatenotificationsubscriptionservice.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Input" + responses: + 200: + description: "Correct response" + schema: + $ref: "#/definitions/tapi.notification.UpdateNotificationSubscriptionService" + 201: + description: "No response" + 400: + description: "Internal error" + /operations/update-service-interface-point/: + post: + tags: + - "tapi-common" + summary: "operates on tapi.common.UpdateServiceInterfacePoint" + description: "operates on tapi.common.UpdateServiceInterfacePoint" + parameters: + - in: "body" + name: "tapi.common.updateserviceinterfacepoint.Input.body-param" + required: false + schema: + properties: + input: + $ref: "#/definitions/tapi.common.updateserviceinterfacepoint.Input" + responses: + 201: + description: "No response" + 400: + description: "Internal error" +definitions: + tapi.common.AdminStatePac: + type: "object" + properties: + operational-state: + description: "none" + $ref: "#/definitions/tapi.common.OperationalState" + lifecycle-state: + description: "none" + $ref: "#/definitions/tapi.common.LifecycleState" + administrative-state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + tapi.common.AdministrativeState: + type: "string" + enum: + - "LOCKED" + - "UNLOCKED" + tapi.common.Capacity: + type: "object" + properties: + total-size: + description: "Total capacity of the TopologicalEntity in MB/s. In case of\ + \ bandwidthProfile, this is expected to same as the committedInformationRate." + $ref: "#/definitions/tapi.common.CapacityValue" + tapi.common.CapacityPac: + type: "object" + properties: + available-capacity: + description: "Capacity available to be assigned." + $ref: "#/definitions/tapi.common.Capacity" + total-potential-capacity: + description: "An optimistic view of the capacity of the TopologicalEntity\ + \ assuming that any shared capacity is available to be taken." + $ref: "#/definitions/tapi.common.Capacity" + tapi.common.CapacityUnit: + type: "string" + enum: + - "TB" + - "TBPS" + - "GB" + - "GBPS" + - "MB" + - "MBPS" + - "KB" + - "KBPS" + - "GHz" + - "MHz" + tapi.common.CapacityValue: + type: "object" + properties: + value: + type: "integer" + format: "int32" + description: "none" + unit: + description: "none" + $ref: "#/definitions/tapi.common.CapacityUnit" + tapi.common.Context: + allOf: + - $ref: "#/definitions/tapi.common.TapiContext" + - $ref: "#/definitions/tapi.notification.ContextAugmentation2" + - $ref: "#/definitions/tapi.topology.ContextAugmentation3" + - $ref: "#/definitions/tapi.virtual.network.ContextAugmentation1" + tapi.common.ForwardingDirection: + type: "string" + enum: + - "BIDIRECTIONAL" + - "UNIDIRECTIONAL" + - "UNDEFINED_OR_UNKNOWN" + tapi.common.GetServiceInterfacePointDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.Output" + tapi.common.GetServiceInterfacePointList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.common.getserviceinterfacepointlist.Output" + tapi.common.GlobalClass: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a UUID\ + \ in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.common.LayerProtocolName: + type: "string" + enum: + - "ODU" + - "ETH" + - "DSR" + - "PHOTONIC_MEDIA" + tapi.common.LifecycleState: + type: "string" + enum: + - "PLANNED" + - "POTENTIAL_AVAILABLE" + - "POTENTIAL_BUSY" + - "INSTALLED" + - "PENDING_REMOVAL" + tapi.common.LocalClass: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + local-id: + type: "string" + description: "none" + tapi.common.NameAndValue: + type: "object" + properties: + value-name: + type: "string" + description: "The name of the value. The value need not have a name." + value: + type: "string" + description: "The value" + tapi.common.OperationalState: + type: "string" + enum: + - "DISABLED" + - "ENABLED" + tapi.common.PortDirection: + type: "string" + enum: + - "BIDIRECTIONAL" + - "INPUT" + - "OUTPUT" + - "UNIDENTIFIED_OR_UNKNOWN" + tapi.common.PortRole: + type: "string" + enum: + - "SYMMETRIC" + - "ROOT" + - "LEAF" + - "TRUNK" + - "UNKNOWN" + tapi.common.ServiceInterfacePoint: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + supported-layer-protocol-qualifier: + type: "array" + description: "none" + items: + type: "string" + layer-protocol-name: + description: "Usage of layerProtocolName [>1] in the ServiceInterfacePoint\ + \ should be considered experimental" + $ref: "#/definitions/tapi.common.LayerProtocolName" + description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ + \ termination and adaptation functions of one or more transport layers. \r\ + \n The structure of LTP supports all transport protocols including\ + \ circuit and packet forms." + tapi.common.ServiceInterfacePointRef: + type: "object" + properties: + service-interface-point-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-common:service-interface-point/tapi-common:uuid" + tapi.common.TapiContext: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + service-interface-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + description: "The Network Control Domain (NCD) object class represents the scope\ + \ of control that a particular SDN controller has with respect to a particular\ + \ network, (i.e., encompassing a designated set of interconnected (virtual)\ + \ network elements)." + tapi.common.TerminationDirection: + type: "string" + enum: + - "BIDIRECTIONAL" + - "SINK" + - "SOURCE" + - "UNDEFINED_OR_UNKNOWN" + tapi.common.TerminationPac: + type: "object" + properties: + termination-direction: + description: "The overall directionality of the LP. \r\n -\ + \ A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\r\n \ + \ - A SINK LP can only contain elements with SINK flows or CONTRA_DIRECTION_SOURCE\ + \ flows\r\n - A SOURCE LP can only contain SOURCE flows or\ + \ CONTRA_DIRECTION_SINK flows" + $ref: "#/definitions/tapi.common.TerminationDirection" + termination-state: + description: "Indicates whether the layer is terminated and if so how." + $ref: "#/definitions/tapi.common.TerminationState" + tapi.common.TerminationState: + type: "string" + enum: + - "LP_CAN_NEVER_TERMINATE" + - "LT_NOT_TERMINATED" + - "TERMINATED_SERVER_TO_CLIENT_FLOW" + - "TERMINATED_CLIENT_TO_SERVER_FLOW" + - "TERMINATED_BIDIRECTIONAL" + - "LT_PERMENANTLY_TERMINATED" + - "TERMINATION_STATE_UNKNOWN" + tapi.common.TimeRange: + type: "object" + properties: + end-time: + type: "string" + description: "none" + start-time: + type: "string" + description: "none" + tapi.common.getserviceinterfacepointdetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.common.getserviceinterfacepointdetails.Output: + type: "object" + properties: + sip: + description: "none" + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + tapi.common.getserviceinterfacepointlist.Output: + type: "object" + properties: + sip: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePoint" + tapi.common.updateserviceinterfacepoint.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdministrativeState" + tapi.notification.ContextAugmentation2: + type: "object" + properties: + notification-context: + description: "Augments the base TAPI Context with NotificationService information" + $ref: "#/definitions/tapi.notification.NotificationContext" + x-augmentation: + prefix: "tapi-notification" + namespace: "urn:onf:otcc:yang:tapi-notification" + tapi.notification.CreateNotificationSubscriptionService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.createnotificationsubscriptionservice.Output" + tapi.notification.GetNotificationList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationlist.Output" + tapi.notification.GetNotificationSubscriptionServiceDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicedetails.Output" + tapi.notification.GetNotificationSubscriptionServiceList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getnotificationsubscriptionservicelist.Output" + tapi.notification.GetSupportedNotificationTypes: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.getsupportednotificationtypes.Output" + tapi.notification.NameAndValueChange: + type: "object" + properties: + value-name: + type: "string" + description: "The name of the value. The value need not have a name." + old-value: + type: "string" + description: "The value" + new-value: + type: "string" + description: "The value" + tapi.notification.Notification: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + target-object-type: + type: "string" + description: "none" + additional-text: + type: "string" + description: "none" + event-time-stamp: + type: "string" + description: "none" + additional-info: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.NameAndValue" + sequence-number: + type: "integer" + format: "int32" + description: "A monotonous increasing sequence number associated with the\ + \ notification.\r\n The exact semantics of how this sequence\ + \ number is assigned (per channel or subscription or source or system)\ + \ is left undefined." + target-object-identifier: + type: "string" + description: "none" + notification-type: + type: "string" + description: "none" + target-object-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.NameAndValue" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + source-indicator: + description: "none" + $ref: "#/definitions/tapi.notification.SourceIndicator" + layer-protocol-qualifier: + type: "string" + description: "none" + changed-attributes: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NameAndValueChange" + description: "none" + tapi.notification.NotificationChannel: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + next-sequence-no: + type: "integer" + format: "int32" + description: "The sequence number of the next notification that will be\ + \ published on the channel" + stream-address: + type: "string" + description: "The address/location/URI of the channel/stream to which the\ + \ subscribed notifications are published.\r\n This specifics\ + \ of this is typically dependent on the implementation protocol & mechanism\ + \ and hence is typed as a string." + description: "none" + tapi.notification.NotificationContext: + type: "object" + properties: + notif-subscription: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.Notification" + tapi.notification.NotificationSubscriptionService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.Notification" + notification-channel: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationChannel" + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + supported-object-types: + type: "array" + description: "none" + items: + type: "string" + supported-notification-types: + type: "array" + description: "none" + items: + type: "string" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + description: "none" + tapi.notification.SourceIndicator: + type: "string" + enum: + - "RESOURCE_OPERATION" + - "MANAGEMENT_OPERATION" + - "UNKNOWN" + tapi.notification.SubscriptionFilter: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + requested-notification-types: + type: "array" + description: "none" + items: + type: "string" + requested-object-identifier: + type: "array" + description: "none" + items: + type: "string" + requested-layer-protocols: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + include-content: + type: "boolean" + description: "Indicates whether the published Notification includes content\ + \ or just the Notification Id (which enables retrieval of the notification\ + \ at the later stage)" + default: false + requested-object-types: + type: "array" + description: "none" + items: + type: "string" + description: "none" + tapi.notification.SubscriptionState: + type: "string" + enum: + - "SUSPENDED" + - "ACTIVE" + tapi.notification.UpdateNotificationSubscriptionService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.notification.updatenotificationsubscriptionservice.Output" + tapi.notification.createnotificationsubscriptionservice.Input: + type: "object" + properties: + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + tapi.notification.createnotificationsubscriptionservice.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.deletenotificationsubscriptionservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationlist.Input: + type: "object" + properties: + time-range: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + subscription-id: + type: "string" + description: "UUID of the associated Notification Subscription Service: An\ + \ identifier that is universally unique within an identifier space, where\ + \ the identifier space is itself globally unique, and immutable.\r\n \ + \ An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationlist.Output: + type: "object" + properties: + notification: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.Notification" + tapi.notification.getnotificationsubscriptionservicedetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.notification.getnotificationsubscriptionservicedetails.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.getnotificationsubscriptionservicelist.Output: + type: "object" + properties: + subscription-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.notification.getsupportednotificationtypes.Output: + type: "object" + properties: + supported-object-types: + type: "array" + description: "none" + items: + type: "string" + supported-notification-types: + type: "array" + description: "none" + items: + type: "string" + tapi.notification.updatenotificationsubscriptionservice.Input: + type: "object" + properties: + subscription-state: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionState" + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + subscription-filter: + description: "none" + $ref: "#/definitions/tapi.notification.SubscriptionFilter" + tapi.notification.updatenotificationsubscriptionservice.Output: + type: "object" + properties: + subscription-service: + description: "none" + $ref: "#/definitions/tapi.notification.NotificationSubscriptionService" + tapi.topology.ContextAugmentation3: + type: "object" + properties: + topology-context: + description: "Augments the base TAPI Context with TopologyService information" + $ref: "#/definitions/tapi.topology.TopologyContext" + x-augmentation: + prefix: "tapi-topology" + namespace: "urn:onf:otcc:yang:tapi-topology" + tapi.topology.CostCharacteristic: + type: "object" + properties: + cost-value: + type: "string" + description: "The specific cost." + cost-algorithm: + type: "string" + description: "The cost may vary based upon some properties of the TopologicalEntity.\ + \ The rules for the variation are conveyed by the costAlgorithm." + cost-name: + type: "string" + description: "The cost characteristic will related to some aspect of the TopologicalEntity\ + \ (e.g. $ cost, routing weight). This aspect will be conveyed by the costName." + tapi.topology.ForwardingRule: + type: "string" + enum: + - "MAY_FORWARD_ACROSS_GROUP" + - "MUST_FORWARD_ACROSS_GROUP" + - "CANNOT_FORWARD_ACROSS_GROUP" + - "NO_STATEMENT_ON_FORWARDING" + tapi.topology.GetLinkDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getlinkdetails.Output" + tapi.topology.GetNodeDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getnodedetails.Output" + tapi.topology.GetNodeEdgePointDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Output" + tapi.topology.GetTopologyDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.gettopologydetails.Output" + tapi.topology.GetTopologyList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.topology.gettopologylist.Output" + tapi.topology.InterRuleGroup: + allOf: + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + associated-node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + rule: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Rule" + description: "none" + tapi.topology.LatencyCharacteristic: + type: "object" + properties: + traffic-property-name: + type: "string" + description: "The identifier of the specific traffic property to which the\ + \ queuing latency applies." + jitter-characteristic: + type: "string" + description: "High frequency deviation from true periodicity of a signal and\ + \ therefore a small high rate of change of transfer latency.\r\n \ + \ Applies to TDM systems (and not packet)." + fixed-latency-characteristic: + type: "string" + description: "A TopologicalEntity suffers delay caused by the realization\ + \ of the servers (e.g. distance related; FEC encoding etc.) along with some\ + \ client specific processing. This is the total average latency effect of\ + \ the TopologicalEntity" + wander-characteristic: + type: "string" + description: "Low frequency deviation from true periodicity of a signal and\ + \ therefore a small low rate of change of transfer latency.\r\n \ + \ Applies to TDM systems (and not packet)." + queing-latency-characteristic: + type: "string" + description: "The specific queuing latency for the traffic property." + tapi.topology.LayerProtocolTransitionPac: + type: "object" + properties: + transitioned-layer-protocol-name: + type: "array" + description: "Provides the ordered structure of layer protocol transitions\ + \ encapsulated in the TopologicalEntity. The ordering relates to the LinkPort\ + \ role." + items: + type: "string" + tapi.topology.Link: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.LayerProtocolTransitionPac" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - $ref: "#/definitions/tapi.topology.ValidationPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + restoration-policy: + description: "none" + $ref: "#/definitions/tapi.topology.RestorationPolicy" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + protection-type: + description: "none" + $ref: "#/definitions/tapi.topology.ProtectionType" + direction: + description: "The directionality of the Link. \r\n Is applicable\ + \ to simple Links where all LinkEnds are BIDIRECTIONAL (the Link will\ + \ be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\ + \ \r\n Is not present in more complex cases." + $ref: "#/definitions/tapi.common.ForwardingDirection" + description: "The Link object class models effective adjacency between two or\ + \ more ForwardingDomains (FD). " + tapi.topology.NepLayerProtocolCapability: + type: "object" + properties: + layer-protocol-qualifier: + type: "string" + description: "none" + number-of-cep-instances: + type: "integer" + format: "int32" + description: "none" + tapi.topology.NetworkTopologyService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.TopologyRef" + description: "none" + tapi.topology.Node: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + encap-topology: + description: "none" + $ref: "#/definitions/tapi.topology.TopologyRef" + node-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroup" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePoint" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ + \ topological component which is used to effect forwarding of transport characteristic\ + \ information and offers the potential to enable forwarding. \r\n \ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ multiple switch matrices (FDs). " + tapi.topology.NodeEdgePoint: + allOf: + - $ref: "#/definitions/tapi.common.AdminStatePac" + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.common.TerminationPac" + - type: "object" + properties: + link-port-role: + description: "Each LinkEnd of the Link has a role (e.g., symmetric, hub,\ + \ spoke, leaf, root) in the context of the Link with respect to the Link\ + \ function. " + $ref: "#/definitions/tapi.common.PortRole" + mapped-service-interface-point: + type: "array" + description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ + \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load\ + \ balancing/Resilience) should be considered experimental" + items: + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + available-cep-layer-protocol: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NepLayerProtocolCapability" + aggregated-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + layer-protocol-name: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + link-port-direction: + description: "The orientation of defined flow at the LinkEnd." + $ref: "#/definitions/tapi.common.PortDirection" + description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ + \ termination and adaptation functions of one or more transport layers. \r\ + \n The structure of LTP supports all transport protocols including\ + \ circuit and packet forms." + tapi.topology.NodeEdgePointRef: + allOf: + - $ref: "#/definitions/tapi.topology.NodeRef" + - type: "object" + properties: + node-edge-point-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-edge-point/tapi-topology:uuid" + description: "none" + tapi.topology.NodeRef: + allOf: + - $ref: "#/definitions/tapi.topology.TopologyRef" + - type: "object" + properties: + node-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:uuid" + description: "none" + tapi.topology.NodeRuleGroup: + allOf: + - $ref: "#/definitions/tapi.common.CapacityPac" + - $ref: "#/definitions/tapi.common.GlobalClass" + - $ref: "#/definitions/tapi.topology.RiskParameterPac" + - $ref: "#/definitions/tapi.topology.TransferCostPac" + - $ref: "#/definitions/tapi.topology.TransferTimingPac" + - type: "object" + properties: + inter-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.InterRuleGroup" + rule: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Rule" + composed-rule-group: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" + node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "none" + tapi.topology.NodeRuleGroupRef: + allOf: + - $ref: "#/definitions/tapi.topology.NodeRef" + - type: "object" + properties: + node-rule-group-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-rule-group/tapi-topology:uuid" + description: "none" + tapi.topology.ProtectionType: + type: "string" + enum: + - "NO_PROTECTION" + - "ONE_PLUS_ONE_PROTECTION" + - "ONE_FOR_ONE_PROTECTION" + - "ONE_FOR_N_PROTECTION" + - "M_FOR_N_PROTECTION" + - "ONE_FOR_ONE_BY_N" + tapi.topology.RestorationPolicy: + type: "string" + enum: + - "PER_DOMAIN_RESTORATION" + - "END_TO_END_RESTORATION" + - "NA" + - "DYNAMIC_RESTORATION" + - "PRE_COMPUTED_RESTORATION" + tapi.topology.RiskCharacteristic: + type: "object" + properties: + risk-characteristic-name: + type: "string" + description: "The name of the risk characteristic. The characteristic may\ + \ be related to a specific degree of closeness. \r\n For\ + \ example a particular characteristic may apply to failures that are localized\ + \ (e.g. to one side of a road) where as another characteristic may relate\ + \ to failures that have a broader impact (e.g. both sides of a road that\ + \ crosses a bridge).\r\n Depending upon the importance of\ + \ the traffic being routed different risk characteristics will be evaluated." + risk-identifier-list: + type: "array" + description: "A list of the identifiers of each physical/geographic unit (with\ + \ the specific risk characteristic) that is related to a segment of the\ + \ TopologicalEntity." + items: + type: "string" + tapi.topology.RiskParameterPac: + type: "object" + properties: + risk-characteristic: + type: "array" + description: "A list of risk characteristics for consideration in an analysis\ + \ of shared risk. Each element of the list represents a specific risk consideration." + items: + $ref: "#/definitions/tapi.topology.RiskCharacteristic" + tapi.topology.Rule: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + override-priority: + type: "integer" + format: "int32" + description: "none" + forwarding-rule: + description: "none" + $ref: "#/definitions/tapi.topology.ForwardingRule" + rule-type: + description: "none" + $ref: "#/definitions/tapi.topology.RuleType" + description: "none" + tapi.topology.RuleType: + type: "string" + enum: + - "FORWARDING" + - "CAPACITY" + - "COST" + - "TIMING" + - "RISK" + - "GROUPING" + tapi.topology.Topology: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + link: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Link" + node: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Node" + boundary-node-edge-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.NodeEdgePointRef" + description: "The ForwardingDomain (FD) object class models the ForwardingDomain\ + \ topological component which is used to effect forwarding of transport characteristic\ + \ information and offers the potential to enable forwarding. \r\n \ + \ At the lowest level of recursion, an FD (within a network element (NE))\ + \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ + \ multiple switch matrices (FDs). " + tapi.topology.TopologyContext: + type: "object" + properties: + nw-topology-service: + description: "none" + $ref: "#/definitions/tapi.topology.NetworkTopologyService" + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.TopologyRef: + type: "object" + properties: + topology-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:uuid" + tapi.topology.TransferCostPac: + type: "object" + properties: + cost-characteristic: + type: "array" + description: "The list of costs where each cost relates to some aspect of\ + \ the TopologicalEntity." + items: + $ref: "#/definitions/tapi.topology.CostCharacteristic" + tapi.topology.TransferIntegrityPac: + type: "object" + properties: + error-characteristic: + type: "string" + description: "Describes the degree to which the signal propagated can be errored.\ + \ \r\n Applies to TDM systems as the errored signal will\ + \ be propagated and not packet as errored packets will be discarded." + unavailable-time-characteristic: + type: "string" + description: "Describes the duration for which there may be no valid signal\ + \ propagated." + server-integrity-process-characteristic: + type: "string" + description: "Describes the effect of any server integrity enhancement process\ + \ on the characteristics of the TopologicalEntity." + delivery-order-characteristic: + type: "string" + description: "Describes the degree to which packets will be delivered out\ + \ of sequence.\r\n Does not apply to TDM as the TDM protocols\ + \ maintain strict order." + repeat-delivery-characteristic: + type: "string" + description: "Primarily applies to packet systems where a packet may be delivered\ + \ more than once (in fault recovery for example). \r\n It\ + \ can also apply to TDM where several frames may be received twice due to\ + \ switching in a system with a large differential propagation delay." + loss-characteristic: + type: "string" + description: "Describes the acceptable characteristic of lost packets where\ + \ loss may result from discard due to errors or overflow.\r\n \ + \ Applies to packet systems and not TDM (as for TDM errored signals\ + \ are propagated unless grossly errored and overflow/underflow turns into\ + \ timing slips)." + tapi.topology.TransferTimingPac: + type: "object" + properties: + latency-characteristic: + type: "array" + description: "The effect on the latency of a queuing process. This only has\ + \ significant effect for packet based systems and has a complex characteristic." + items: + $ref: "#/definitions/tapi.topology.LatencyCharacteristic" + tapi.topology.ValidationMechanism: + type: "object" + properties: + layer-protocol-adjacency-validated: + type: "string" + description: "State of validatiion" + validation-mechanism: + type: "string" + description: "Name of mechanism used to validate adjacency" + validation-robustness: + type: "string" + description: "Quality of validation (i.e. how likely is the stated validation\ + \ to be invalid)" + tapi.topology.ValidationPac: + type: "object" + properties: + validation-mechanism: + type: "array" + description: "Provides details of the specific validation mechanism(s) used\ + \ to confirm the presence of an intended topologicalEntity." + items: + $ref: "#/definitions/tapi.topology.ValidationMechanism" + tapi.topology.getlinkdetails.Input: + type: "object" + properties: + link-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getlinkdetails.Output: + type: "object" + properties: + link: + description: "none" + $ref: "#/definitions/tapi.topology.Link" + tapi.topology.getnodedetails.Input: + type: "object" + properties: + node-id: + type: "string" + description: "UUID of the Node: An identifier that is universally unique within\ + \ an identifier space, where the identifier space is itself globally unique,\ + \ and immutable.\r\n An UUID carries no semantics with\ + \ respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The canonical\ + \ representation uses lowercase characters.\r\n Pattern:\ + \ [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getnodedetails.Output: + type: "object" + properties: + node: + description: "none" + $ref: "#/definitions/tapi.topology.Node" + tapi.topology.getnodeedgepointdetails.Input: + type: "object" + properties: + node-id: + type: "string" + description: "UUID of the parent Node: An identifier that is universally unique\ + \ within an identifier space, where the identifier space is itself globally\ + \ unique, and immutable.\r\n An UUID carries no semantics\ + \ with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC 4122. The\ + \ canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\ + \ \r\n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + topology-id: + type: "string" + description: "UUID of the parent Node's Topology: An identifier that is universally\ + \ unique within an identifier space, where the identifier space is itself\ + \ globally unique, and immutable.\r\n An UUID carries\ + \ no semantics with respect to the purpose or state of the entity.\r\n \ + \ UUID here uses string representation as defined in RFC\ + \ 4122. The canonical representation uses lowercase characters.\r\n \ + \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + node-edge-point-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.getnodeedgepointdetails.Output: + type: "object" + properties: + node-edge-point: + description: "none" + $ref: "#/definitions/tapi.topology.NodeEdgePoint" + tapi.topology.gettopologydetails.Input: + type: "object" + properties: + topology-id: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.topology.gettopologydetails.Output: + type: "object" + properties: + topology: + description: "none" + $ref: "#/definitions/tapi.topology.Topology" + tapi.topology.gettopologylist.Output: + type: "object" + properties: + topology: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.topology.Topology" + tapi.virtual.network.ContextAugmentation1: + type: "object" + properties: + virtual-network-context: + description: "Augments the base TAPI Context with VirtualNetworkService information" + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkContext" + x-augmentation: + prefix: "tapi-virtual-network" + namespace: "urn:onf:otcc:yang:tapi-virtual-network" + tapi.virtual.network.CreateVirtualNetworkService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.virtual.network.createvirtualnetworkservice.Output" + tapi.virtual.network.DeleteVirtualNetworkService: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.virtual.network.deletevirtualnetworkservice.Output" + tapi.virtual.network.GetVirtualNetworkServiceDetails: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.virtual.network.getvirtualnetworkservicedetails.Output" + tapi.virtual.network.GetVirtualNetworkServiceList: + type: "object" + properties: + output: + $ref: "#/definitions/tapi.virtual.network.getvirtualnetworkservicelist.Output" + tapi.virtual.network.VirtualNetworkConstraint: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + service-layer: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + requested-capacity: + description: "none" + $ref: "#/definitions/tapi.common.Capacity" + sink-service-end-point: + description: "none" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + diversity-exclusion: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.virtual.network.VirtualNwServiceRef" + src-service-end-point: + description: "none" + $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" + 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" + 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" + 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" + description: "none" + tapi.virtual.network.VirtualNetworkContext: + type: "object" + properties: + virtual-nw-service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkService" + tapi.virtual.network.VirtualNetworkService: + allOf: + - $ref: "#/definitions/tapi.common.GlobalClass" + - type: "object" + properties: + schedule: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkServiceEndPoint" + topology: + description: "none" + $ref: "#/definitions/tapi.topology.TopologyRef" + layer-protocol-name: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.common.LayerProtocolName" + state: + description: "none" + $ref: "#/definitions/tapi.common.AdminStatePac" + vnw-constraint: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkConstraint" + description: "The ForwardingConstruct (FC) object class models enabled potential\ + \ for forwarding between two or more LTPs and like the LTP supports any transport\ + \ protocol including all circuit and packet forms.\r\n At the lowest\ + \ level of recursion, a FC represents a cross-connection within an NE." + tapi.virtual.network.VirtualNetworkServiceEndPoint: + allOf: + - $ref: "#/definitions/tapi.common.LocalClass" + - type: "object" + properties: + service-layer: + description: "none" + $ref: "#/definitions/tapi.common.LayerProtocolName" + 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" + direction: + description: "The orientation of defined flow at the EndPoint." + $ref: "#/definitions/tapi.common.PortDirection" + description: "The association of the FC to LTPs is made via EndPoints.\r\n \ + \ The EndPoint (EP) object class models the access to the FC function.\ + \ \r\n The traffic forwarding between the associated EPs of the\ + \ FC depends upon the type of FC and may be associated with FcSwitch object\ + \ instances. \r\n In cases where there is resilience the EndPoint\ + \ may convey the resilience role of the access to the FC. \r\n \ + \ It can represent a protected (resilient/reliable) point or a protecting\ + \ (unreliable working or protection) point.\r\n The EP replaces\ + \ the Protection Unit of a traditional protection model. \r\n The\ + \ ForwadingConstruct can be considered as a component and the EndPoint as\ + \ a Port on that component" + tapi.virtual.network.VirtualNwServiceRef: + type: "object" + properties: + virtual-nw-service-uuid: + type: "string" + description: "none" + x-path: "/tapi-common:context/tapi-virtual-network:virtual-network-context/tapi-virtual-network:virtual-nw-service/tapi-virtual-network:uuid" + tapi.virtual.network.createvirtualnetworkservice.Input: + type: "object" + properties: + name: + type: "array" + description: "List of names. This value is unique in some namespace but may\ + \ change during the life of the entity.\r\n A name carries\ + \ no semantics with respect to the purpose of the entity." + items: + $ref: "#/definitions/tapi.common.NameAndValue" + schedule: + description: "none" + $ref: "#/definitions/tapi.common.TimeRange" + vnw-constraint: + description: "none" + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkConstraint" + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + end-point: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkServiceEndPoint" + tapi.virtual.network.createvirtualnetworkservice.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkService" + tapi.virtual.network.deletevirtualnetworkservice.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.virtual.network.deletevirtualnetworkservice.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkService" + tapi.virtual.network.getvirtualnetworkservicedetails.Input: + type: "object" + properties: + uuid: + type: "string" + description: "UUID: An identifier that is universally unique within an identifier\ + \ space, where the identifier space is itself globally unique, and immutable.\r\ + \n An UUID carries no semantics with respect to the purpose\ + \ or state of the entity.\r\n UUID here uses string representation\ + \ as defined in RFC 4122. The canonical representation uses lowercase characters.\r\ + \n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ + \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \r\n Example of a\ + \ UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" + tapi.virtual.network.getvirtualnetworkservicedetails.Output: + type: "object" + properties: + service: + description: "none" + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkService" + tapi.virtual.network.getvirtualnetworkservicelist.Output: + type: "object" + properties: + service: + type: "array" + description: "none" + items: + $ref: "#/definitions/tapi.virtual.network.VirtualNetworkService" From c88ce6327ff4cfd9c22d97f1c20d895680532486 Mon Sep 17 00:00:00 2001 From: karthik-sethuraman Date: Fri, 5 Jul 2019 09:31:59 -0400 Subject: [PATCH 3/3] Change-log for version 2.2.0-RC3 --- CHANGE_LOG/change-log.2.2.0.html | 177 +++++++++++++++++++++++++++++++ CHANGE_LOG/change-log.2.2.0.md | 89 ++++++++++++++++ 2 files changed, 266 insertions(+) diff --git a/CHANGE_LOG/change-log.2.2.0.html b/CHANGE_LOG/change-log.2.2.0.html index bccc30ba..167ba595 100644 --- a/CHANGE_LOG/change-log.2.2.0.html +++ b/CHANGE_LOG/change-log.2.2.0.html @@ -34,6 +34,183 @@

Commit Range: v2.2.1..HEAD

+ + + 2019-07-05T08:46:14 05-Jul-2019 08:46 + karthik-sethuraman + + + OAS Files for TAPI 2.2 + + 
EAD -> refs/heads/develop, refs/remotes/origin/develop
+
+ + + + + + + 2019-07-01T11:41:20 01-Jul-2019 11:41 + karthik-sethuraman + + + Removed old OAS files in prep for 2.2-RC3 + + 
+
+ + + + + + + 2019-06-28T18:22:11 28-Jun-2019 18:22 + karthik-sethuraman + + + UML/YANG/TREE file updates to align & be consistent with PR #441 + + 
+- Updated all UML-Operations/YANG-RPCs to use UUIDs so that it is consistent
+with the REST CRUD data APIs flavor
+- used consistent labels (uuid) for the UUID key parameters and fixed parameter
+type to TapiCommon::Uuid (instead of String)
+- other minor bug fixes (explicit config=false statements)
+ + + + + + + 2019-06-28T14:32:47 28-Jun-2019 14:32 + Karthik Sethuraman + + + Yang updates related to PR #428 + + 
+- minor UML organization to move atrifacts into appropriate folders
+ + + + + + + 2019-06-28T10:57:15 28-Jun-2019 10:57 + Karthik Sethuraman + + + UML & corresponding Yang updates to align with PR #439 + + 
+- created an CentralFrequencyBand datatype and using that in OtsiCapability pac
+instead of in-lining as in previous Yang commit
+ + + + + + + 2019-06-26T10:10:50 26-Jun-2019 10:10 + amazzini + + + PathComputationService uuid, name + + 
+Issue #433, add "name" as input parameter of create and update 
+PathComputationService. Issue #340, add "UUID" as input parameter of create 
+PathComputationService.
+ + + + + + + 2019-06-26T10:06:36 26-Jun-2019 10:06 + amazzini + + + OAM Service/Job/Profile uuid,name,layerProtocolName + + 
+Issue #434, add "layerProtocolName" as input parameter of create OAM 
+Service/ServicePoint/Job/Profile. Issue #433, add "name" as input parameter of
+create and update OAM Service/ServicePoint/Job/Profile. Issue #340, add "UUID"
+as input parameter of create OAM Service/ServicePoint/Job/Profile.
+ + + + + + + 2019-06-26T10:03:22 26-Jun-2019 10:03 + amazzini + + + ConnectivityService uuid,name,layerProtocolName,direction + + 
+Issue #425, set “direction” attribute of ConnectivityService as read only. 
+Issue #434, add "layerProtocolName" as input parameter of create Connectivity
+Service. Issue #433, add "name" as input parameter of create and update 
+ConnectivityService. Issue #340, add "UUID" as input parameter of create
+ConnectivityService.
+ + + + + + + 2019-06-26T05:43:19 26-Jun-2019 05:43 + Arturo Mayoral + + + OTSI SIP spec #429 + + 
+This pull request replace current definition of the otsi tunability
+capabilities as two separate lists: supportable-lower-central-frequency and
+supportable-upper-central-frequency, by a single
+supportable-central-frequency-spectrum-band. After discussions into the TAPI
+calls on18/06/2019 and 25/06/2019, the group agreed on defining the tunabilty
+capabilities of otsi transmitters as a single list of bands defined by the
+lower and upper central frequencies of the band, and the frequency-contrains
+which specify the rest of feasible central frequencies within the band. An OTSi
+transmitter can have associated more than one band (i.e., C and L bands).
+
+ + + + + + + 2019-05-31T13:31:05 31-May-2019 13:31 + amazzini + + + Updated Ethernet TAPI Alarm Condition (G.8021/G.8051/G.806) + + 
+
+ + + + + + + 2019-05-24T08:22:34 24-May-2019 08:22 + karthik-sethuraman + + + Change-log for version 2.2.0-RC2 + + 
+
+ + + + 2019-05-23T13:07:09 23-May-2019 13:07 diff --git a/CHANGE_LOG/change-log.2.2.0.md b/CHANGE_LOG/change-log.2.2.0.md index 156240b9..f50bd6e8 100644 --- a/CHANGE_LOG/change-log.2.2.0.md +++ b/CHANGE_LOG/change-log.2.2.0.md @@ -1,6 +1,95 @@ # Change Log ## Commit Range: 2.1.1..HEAD +__[OAS Files for TAPI 2.2](https://github.com/OpenNetworkingFoundation/TAPI/commit/ad6d1b54eb103831b8480b4af1e39ad90a20b907)__ + + [karthik-sethuraman](mailto:karthik.sethuraman@necam.com) - Fri, 5 Jul 2019 08:46:14 -0400 + EAD -> refs/heads/develop, refs/remotes/origin/develop + + +__[Removed old OAS files in prep for 2.2-RC3](https://github.com/OpenNetworkingFoundation/TAPI/commit/6976123cae404bb883c8f4e05bfb6b72a1d774a4)__ + + [karthik-sethuraman](mailto:karthik.sethuraman@necam.com) - Mon, 1 Jul 2019 11:41:20 -0400 + + + +__[UML/YANG/TREE file updates to align & be consistent with PR #441](https://github.com/OpenNetworkingFoundation/TAPI/commit/fff795940f9f3a9cebe8971a2537cb6764228d61)__ + + [karthik-sethuraman](mailto:karthik.sethuraman@necam.com) - Fri, 28 Jun 2019 18:22:11 -0400 + + - Updated all UML-Operations/YANG-RPCs to use UUIDs so that it is consistent + with the REST CRUD data APIs flavor + - used consistent labels (uuid) for the UUID key parameters and fixed parameter + type to TapiCommon::Uuid (instead of String) + - other minor bug fixes (explicit config=false statements) + +__[Yang updates related to PR #428](https://github.com/OpenNetworkingFoundation/TAPI/commit/a7677de36cbcc1106862d506a046d054f570ff53)__ + + [Karthik Sethuraman](mailto:karthik.sethuraman@necam.com) - Fri, 28 Jun 2019 14:32:47 -0400 + + - minor UML organization to move atrifacts into appropriate folders + +__[UML & corresponding Yang updates to align with PR #439](https://github.com/OpenNetworkingFoundation/TAPI/commit/6655e1388d1f4be0ba3c8b29e4960505588940fb)__ + + [Karthik Sethuraman](mailto:karthik.sethuraman@necam.com) - Fri, 28 Jun 2019 10:57:15 -0400 + + - created an CentralFrequencyBand datatype and using that in OtsiCapability pac + instead of in-lining as in previous Yang commit + +__[PathComputationService uuid, name](https://github.com/OpenNetworkingFoundation/TAPI/commit/8440938381a33559d038d7ad3e614cd7f497caed)__ + + [amazzini](mailto:mazzini64@tiscali.it) - Wed, 26 Jun 2019 16:10:50 +0200 + + Issue #433, add "name" as input parameter of create and update + PathComputationService. Issue #340, add "UUID" as input parameter of create + PathComputationService. + +__[OAM Service/Job/Profile uuid,name,layerProtocolName](https://github.com/OpenNetworkingFoundation/TAPI/commit/8c47dee14af58affc44b0e54c7be37929b57b115)__ + + [amazzini](mailto:mazzini64@tiscali.it) - Wed, 26 Jun 2019 16:06:36 +0200 + + Issue #434, add "layerProtocolName" as input parameter of create OAM + Service/ServicePoint/Job/Profile. Issue #433, add "name" as input parameter of + create and update OAM Service/ServicePoint/Job/Profile. Issue #340, add "UUID" + as input parameter of create OAM Service/ServicePoint/Job/Profile. + +__[ConnectivityService uuid,name,layerProtocolName,direction](https://github.com/OpenNetworkingFoundation/TAPI/commit/58377da11763f33f44411206fa78ce28840cfcf2)__ + + [amazzini](mailto:mazzini64@tiscali.it) - Wed, 26 Jun 2019 16:03:22 +0200 + + Issue #425, set “direction” attribute of ConnectivityService as read only. + Issue #434, add "layerProtocolName" as input parameter of create Connectivity + Service. Issue #433, add "name" as input parameter of create and update + ConnectivityService. Issue #340, add "UUID" as input parameter of create + ConnectivityService. + +__[OTSI SIP spec #429](https://github.com/OpenNetworkingFoundation/TAPI/commit/955108a5491bf586f094dc9d398caecb110de1a4)__ + + [Arturo Mayoral](mailto:arturo.mayoral.ext@telefonica.com) - Wed, 26 Jun 2019 11:43:19 +0200 + + This pull request replace current definition of the otsi tunability + capabilities as two separate lists: supportable-lower-central-frequency and + supportable-upper-central-frequency, by a single + supportable-central-frequency-spectrum-band. After discussions into the TAPI + calls on18/06/2019 and 25/06/2019, the group agreed on defining the tunabilty + capabilities of otsi transmitters as a single list of bands defined by the + lower and upper central frequencies of the band, and the frequency-contrains + which specify the rest of feasible central frequencies within the band. An OTSi + transmitter can have associated more than one band (i.e., C and L bands). + + +__[Updated Ethernet TAPI Alarm Condition (G.8021/G.8051/G.806)](https://github.com/OpenNetworkingFoundation/TAPI/commit/a755b7dec3b99a9f367d3364a5f2cf6475f8ebe8)__ + + [amazzini](mailto:mazzini64@tiscali.it) - Fri, 31 May 2019 19:31:05 +0200 + + + +__[Change-log for version 2.2.0-RC2](https://github.com/OpenNetworkingFoundation/TAPI/commit/7823102f708488dff2228adb680b8ab88550700a)__ + + [karthik-sethuraman](mailto:karthik.sethuraman@necam.com) - Fri, 24 May 2019 08:22:34 -0400 + + + __[Changed the multiplicity of Connection.boundingNode to 0..1 from 1](https://github.com/OpenNetworkingFoundation/TAPI/commit/6b1379e25c1e42542ba8f48dcd02c76ac6efbcdf)__ [karthik-sethuraman](mailto:karthik.sethuraman@necam.com) - Thu, 23 May 2019 13:07:09 -0400