tapi-connectivity.yaml

  tapi.path.computation.DiversityPolicy:
    type: "string"
    enum:
    - "SRLG"
    - "SRNG"
    - "SNG"
    - "NODE"
    - "LINK"
  tapi.path.computation.OptimizeP2Ppath:
    type: "object"
    properties:
      output:
        $ref: "#/definitions/tapi.path.computation.optimizep2ppath.Output"
  tapi.path.computation.Path:
    allOf:
    - $ref: "#/definitions/tapi.common.GlobalClass"
    - type: "object"
      properties:
        layer-protocol-name:
          description: "none"
          $ref: "#/definitions/tapi.common.LayerProtocolName"
        link:
          type: "array"
          description: "none"
          items:
            $ref: "#/definitions/tapi.topology.LinkRef"
        routing-constraint:
          description: "none"
          $ref: "#/definitions/tapi.path.computation.RoutingConstraint"
        direction:
          description: "none"
          $ref: "#/definitions/tapi.common.ForwardingDirection"
      description: "Path is described by an ordered list of TE Links. A TE Link is\
        \ defined by a pair of Node/NodeEdgePoint IDs. A Connection is realized by\
        \ concatenating link resources (associated with a Link) and the lower-level\
        \ connections (cross-connections) in the different nodes"
  tapi.path.computation.PathComputationContext:
    type: "object"
    properties:
      path-comp-service:
        type: "array"
        description: "none"
        items:
          $ref: "#/definitions/tapi.path.computation.PathComputationService"
      path:
        type: "array"
        description: "none"
        items:
          $ref: "#/definitions/tapi.path.computation.Path"
  tapi.path.computation.PathComputationContextWrapper:
    properties:
      tapi-path-computation:path-computation-context:
        $ref: "#/definitions/tapi.path.computation.PathComputationContext"
  tapi.path.computation.PathComputationService:
    allOf:
    - $ref: "#/definitions/tapi.common.GlobalClass"
    - type: "object"
      properties:
        topology-constraint:
          description: "none"
          $ref: "#/definitions/tapi.path.computation.TopologyConstraint"
        path:
          type: "array"
          description: "none"
          items:
            $ref: "#/definitions/tapi.path.computation.PathRef"
        objective-function:
          description: "none"
          $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction"
        end-point:
          type: "array"
          description: "none"
          items:
            $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint"
        routing-constraint:
          description: "none"
          $ref: "#/definitions/tapi.path.computation.RoutingConstraint"
        optimization-constraint:
          description: "none"
          $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint"
      description: "none"
  tapi.path.computation.PathComputationServiceWrapper:
    properties:
      path-comp-service:
        $ref: "#/definitions/tapi.path.computation.PathComputationService"
  tapi.path.computation.PathObjectiveFunction:
    allOf:
    - $ref: "#/definitions/tapi.common.LocalClass"
    - type: "object"
      properties:
        link-utilization:
          description: "none"
          $ref: "#/definitions/tapi.common.DirectiveValue"
        bandwidth-optimization:
          description: "none"
          $ref: "#/definitions/tapi.common.DirectiveValue"
        cost-optimization:
          description: "none"
          $ref: "#/definitions/tapi.common.DirectiveValue"
        resource-sharing:
          description: "none"
          $ref: "#/definitions/tapi.common.DirectiveValue"
        concurrent-paths:
          description: "none"
          $ref: "#/definitions/tapi.common.DirectiveValue"
      description: "none"
  tapi.path.computation.PathObjectiveFunctionWrapper:
    properties:
      objective-function:
        $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction"
  tapi.path.computation.PathOptimizationConstraint:
    allOf:
    - $ref: "#/definitions/tapi.common.LocalClass"
    - type: "object"
      properties:
        traffic-interruption:
          description: "none"
          $ref: "#/definitions/tapi.common.DirectiveValue"
      description: "none"
  tapi.path.computation.PathOptimizationConstraintWrapper:
    properties:
      optimization-constraint:
        $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint"
  tapi.path.computation.PathRef:
    type: "object"
    properties:
      path-uuid:
        type: "string"
        description: "none"
        x-path: "/tapi-common:context/tapi-path-computation:path-computation-context/tapi-path-computation:path/tapi-path-computation:uuid"
  tapi.path.computation.PathRefWrapper:
    properties:
      path:
        $ref: "#/definitions/tapi.path.computation.PathRef"
  tapi.path.computation.PathServiceEndPoint:
    allOf:
    - $ref: "#/definitions/tapi.common.LocalClass"
    - type: "object"
      properties:
        role:
          description: "Each EP of the FC has a role (e.g., working, protection, protected,\
            \ symmetric, hub, spoke, leaf, root)  in the context of the FC with respect\
            \ to the FC function. "
          $ref: "#/definitions/tapi.common.PortRole"
        service-interface-point:
          description: "none"
          $ref: "#/definitions/tapi.common.ServiceInterfacePointRef"
        layer-protocol-name:
          description: "none"
          $ref: "#/definitions/tapi.common.LayerProtocolName"
        layer-protocol-qualifier:
          type: "string"
          description: "none"
        direction:
          description: "The orientation of defined flow at the EndPoint."
          $ref: "#/definitions/tapi.common.PortDirection"
        capacity:
          description: "none"
          $ref: "#/definitions/tapi.common.Capacity"
      description: "The association of the FC to LTPs is made via EndPoints.\r\n \
        \           The EndPoint (EP) object class models the access to the FC function.\
        \ \r\n            The traffic forwarding between the associated EPs of the\
        \ FC depends upon the type of FC and may be associated with FcSwitch object\
        \ instances.  \r\n            In cases where there is resilience the EndPoint\
        \ may convey the resilience role of the access to the FC. \r\n           \
        \ It can represent a protected (resilient/reliable) point or a protecting\
        \ (unreliable working or protection) point.\r\n            The EP replaces\
        \ the Protection Unit of a traditional protection model. \r\n            The\
        \ ForwadingConstruct can be considered as a component and the EndPoint as\
        \ a Port on that component"
  tapi.path.computation.PathServiceEndPointWrapper:
    properties:
      end-point:
        $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint"
  tapi.path.computation.PathWrapper:
    properties:
      path:
        $ref: "#/definitions/tapi.path.computation.Path"
  tapi.path.computation.RouteObjectiveFunction:
    type: "string"
    enum:
    - "MIN_WORK_ROUTE_HOP"
    - "MIN_WORK_ROUTE_COST"
    - "MIN_WORK_ROUTE_LATENCY"
    - "MIN_SUM_OF_WORK_AND_PROTECTION_ROUTE_HOP"
    - "MIN_SUM_OF_WORK_AND_PROTECTION_ROUTE_COST"
    - "MIN_SUM_OF_WORK_AND_PROTECTION_ROUTE_LATENCY"
    - "LOAD_BALANCE_MAX_UNUSED_CAPACITY"
  tapi.path.computation.RoutingConstraint:
    type: "object"
    properties:
      is-exclusive:
        type: "boolean"
        description: "To distinguish if the resources are to be exclusive to the service"
        default: true
      max-allowed-cost:
        description: "none"
        $ref: "#/definitions/tapi.path.computation.ValueOrPriority"
      diversity-policy:
        description: "none"
        $ref: "#/definitions/tapi.path.computation.DiversityPolicy"
      route-objective-function:
        description: "none"
        $ref: "#/definitions/tapi.path.computation.RouteObjectiveFunction"
      cost-characteristic:
        type: "array"
        description: "The list of costs where each cost relates to some aspect of\
          \ the TopologicalEntity."
        items:
          $ref: "#/definitions/tapi.topology.CostCharacteristic"
      max-allowed-hops:
        description: "none"
        $ref: "#/definitions/tapi.path.computation.ValueOrPriority"
      max-allowed-delay:
        description: "Delay unit is microseconds."
        $ref: "#/definitions/tapi.path.computation.ValueOrPriority"
      latency-characteristic:
        type: "array"
        description: "The effect on the latency of a queuing process. This only has\
          \ significant effect for packet based systems and has a complex characteristic."
        items:
          $ref: "#/definitions/tapi.topology.LatencyCharacteristic"
      risk-diversity-characteristic:
        type: "array"
        description: "none"
        items:
          $ref: "#/definitions/tapi.topology.RiskCharacteristic"
      route-direction:
        description: "none"
        $ref: "#/definitions/tapi.common.ForwardingDirection"
  tapi.path.computation.RoutingConstraintWrapper:
    properties:
      routing-constraint:
        $ref: "#/definitions/tapi.path.computation.RoutingConstraint"
  tapi.path.computation.TopologyConstraint:
    type: "object"
    properties:
      include-node:
        type: "array"
        description: "This is a loose constraint - that is it is unordered and could\
          \ be a partial list"
        items:
          type: "string"
      exclude-link:
        type: "array"
        description: "none"
        items:
          type: "string"
      avoid-topology:
        type: "array"
        description: "none"
        items:
          type: "string"
      exclude-path:
        type: "array"
        description: "none"
        items:
          type: "string"
      include-link:
        type: "array"
        description: "This is a loose constraint - that is it is unordered and could\
          \ be a partial list "
        items:
          type: "string"
      preferred-transport-layer:
        type: "array"
        description: "soft constraint requested by client to indicate the layer(s)\
          \ of transport connection that it prefers to carry the service. This could\
          \ be same as the service layer or one of the supported server layers"
        items:
          $ref: "#/definitions/tapi.common.LayerProtocolName"
      exclude-node:
        type: "array"
        description: "none"
        items:
          type: "string"
      include-topology:
        type: "array"
        description: "none"
        items:
          type: "string"
      include-path:
        type: "array"
        description: "none"
        items:
          type: "string"
  tapi.path.computation.TopologyConstraintWrapper:
    properties:
      topology-constraint:
        $ref: "#/definitions/tapi.path.computation.TopologyConstraint"
  tapi.path.computation.ValueOrPriority:
    type: "object"
    properties:
      priority:
        type: "integer"
        format: "int32"
        description: "none"
      value:
        type: "integer"
        format: "int32"
        description: "none"
  tapi.path.computation.ValueOrPriorityWrapper:
    properties:
      max-allowed-cost:
        $ref: "#/definitions/tapi.path.computation.ValueOrPriority"
  tapi.path.computation.computep2ppath.Input:
    type: "object"
    properties:
      topology-constraint:
        description: "none"
        $ref: "#/definitions/tapi.path.computation.TopologyConstraint"
      routing-constraint:
        description: "none"
        $ref: "#/definitions/tapi.path.computation.RoutingConstraint"
      objective-function:
        description: "none"
        $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction"
      sep:
        type: "array"
        description: "none"
        items:
          $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint"
  tapi.path.computation.computep2ppath.Output:
    type: "object"
    properties:
      service:
        description: "none"
        $ref: "#/definitions/tapi.path.computation.PathComputationService"
  tapi.path.computation.deletep2ppath.Input:
    type: "object"
    properties:
      path-id-or-name:
        type: "string"
        description: "none"
  tapi.path.computation.deletep2ppath.Output:
    type: "object"
    properties:
      service:
        description: "none"
        $ref: "#/definitions/tapi.path.computation.PathComputationService"
  tapi.path.computation.optimizep2ppath.Input:
    type: "object"
    properties:
      routing-constraint:
        description: "none"
        $ref: "#/definitions/tapi.path.computation.RoutingConstraint"
      path-id-or-name:
        type: "string"
        description: "none"
      optimization-constraint:
        description: "none"
        $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint"
      objective-function:
        description: "none"
        $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction"
  tapi.path.computation.optimizep2ppath.Output:
    type: "object"
    properties:
      service:
        description: "none"
        $ref: "#/definitions/tapi.path.computation.PathComputationService"
  tapi.topology.ConnectionSpecReference:
    type: "object"
    properties:
      connection-spec-name:
        type: "string"
        description: "The name of the connection type spec.\r\n                This\
          \ can be used as a reference to a paper document where full formal machine\
          \ interpretable specs are not supported."
      connection-spec-id:
        type: "string"
        description: "The reference to a formal spec. \r\n                This reference\
          \ need not be provided (e.g., where there is no formal machine interpretable\
          \ spec for the type of connection)."
  tapi.topology.ConnectionSpecReferenceWrapper:
    properties:
      connection-spec-reference:
        $ref: "#/definitions/tapi.topology.ConnectionSpecReference"
  tapi.topology.ContextAugmentation4:
    type: "object"
    properties:
      topology-context:
        description: "Augments the base TAPI Context with TopologyService information"
        $ref: "#/definitions/tapi.topology.TopologyContext"
    x-augmentation:
      prefix: "tapi-topology"
      namespace: "urn:onf:otcc:yang:tapi-topology"
  tapi.topology.CostCharacteristic:
    type: "object"
    properties:
      cost-value:
        type: "string"
        description: "The specific cost."
      cost-algorithm:
        type: "string"
        description: "The cost may vary based upon some properties of the TopologicalEntity.\
          \ The rules for the variation are conveyed by the costAlgorithm."
      cost-name:
        type: "string"
        description: "The cost characteristic will related to some aspect of the TopologicalEntity\
          \ (e.g. $ cost, routing weight). This aspect will be conveyed by the costName."
  tapi.topology.CostCharacteristicWrapper:
    properties:
      cost-characteristic:
        $ref: "#/definitions/tapi.topology.CostCharacteristic"
  tapi.topology.ForwardingRule:
    type: "string"
    enum:
    - "MAY_FORWARD_ACROSS_GROUP"
    - "MUST_FORWARD_ACROSS_GROUP"
    - "CANNOT_FORWARD_ACROSS_GROUP"
    - "NO_STATEMENT_ON_FORWARDING"
    - "INTER_CONNECTION_CONTENTION"
  tapi.topology.GetLinkDetails:
    type: "object"
    properties:
      output:
        $ref: "#/definitions/tapi.topology.getlinkdetails.Output"
  tapi.topology.GetNodeDetails:
    type: "object"
    properties:
      output:
        $ref: "#/definitions/tapi.topology.getnodedetails.Output"
  tapi.topology.GetNodeEdgePointDetails:
    type: "object"
    properties:
      output:
        $ref: "#/definitions/tapi.topology.getnodeedgepointdetails.Output"
  tapi.topology.GetTopologyDetails:
    type: "object"
    properties:
      output:
        $ref: "#/definitions/tapi.topology.gettopologydetails.Output"
  tapi.topology.GetTopologyList:
    type: "object"
    properties:
      output:
        $ref: "#/definitions/tapi.topology.gettopologylist.Output"
  tapi.topology.InterRuleGroup:
    allOf:
    - $ref: "#/definitions/tapi.common.CapacityPac"
    - $ref: "#/definitions/tapi.common.GlobalClass"
    - $ref: "#/definitions/tapi.topology.RiskParameterPac"
    - $ref: "#/definitions/tapi.topology.TransferCostPac"
    - $ref: "#/definitions/tapi.topology.TransferTimingPac"
    - type: "object"
      properties:
        associated-node-rule-group:
          type: "array"
          description: "The NodeRuleGroups that the InterRuleGroup constrains interconnection\
            \ between.\r\n                The CEPs of the NEPs of a referenced NodeRuleGroup\
            \ can interconnect to the CEPs of the NEPs of another referenced NodeRuleGroup\
            \ constrained by the rules of the InterRuleGroup."
          items:
            $ref: "#/definitions/tapi.topology.NodeRuleGroupRef"
        rule:
          type: "array"
          description: "The list of rules of the InterRuleGroup."
          items:
            $ref: "#/definitions/tapi.topology.Rule"
      description: "Rules that apply between groups of NEPs."
  tapi.topology.InterRuleGroupWrapper:
    properties:
      inter-rule-group:
        $ref: "#/definitions/tapi.topology.InterRuleGroup"
  tapi.topology.LatencyCharacteristic:
    type: "object"
    properties:
      traffic-property-name:
        type: "string"
        description: "The identifier of the specific traffic property to which the\
          \ queuing latency applies."
      jitter-characteristic:
        type: "string"
        description: "High frequency deviation from true periodicity of a signal and\
          \ therefore a small high rate of change of transfer latency.\r\n       \
          \         Applies to TDM systems (and not packet)."
      fixed-latency-characteristic:
        type: "string"
        description: "A TopologicalEntity suffers delay caused by the realization\
          \ of the servers (e.g. distance related; FEC encoding etc.) along with some\
          \ client specific processing. This is the total average latency effect of\
          \ the TopologicalEntity"
      wander-characteristic:
        type: "string"
        description: "Low frequency deviation from true periodicity of a signal and\
          \ therefore a small low rate of change of transfer latency.\r\n        \
          \        Applies to TDM systems (and not packet)."
      queing-latency-characteristic:
        type: "string"
        description: "The specific queuing latency for the traffic property."
  tapi.topology.LatencyCharacteristicWrapper:
    properties:
      latency-characteristic:
        $ref: "#/definitions/tapi.topology.LatencyCharacteristic"
  tapi.topology.LayerProtocolTransitionPac:
    type: "object"
    properties:
      transitioned-layer-protocol-name:
        type: "array"
        description: "Provides the ordered structure of layer protocol transitions\
          \ encapsulated in the TopologicalEntity. The ordering relates to the LinkPort\
          \ role."
        items:
          type: "string"
  tapi.topology.Link:
    allOf:
    - $ref: "#/definitions/tapi.common.AdminStatePac"
    - $ref: "#/definitions/tapi.common.CapacityPac"
    - $ref: "#/definitions/tapi.common.GlobalClass"
    - $ref: "#/definitions/tapi.topology.LayerProtocolTransitionPac"
    - $ref: "#/definitions/tapi.topology.RiskParameterPac"
    - $ref: "#/definitions/tapi.topology.TransferCostPac"
    - $ref: "#/definitions/tapi.topology.TransferIntegrityPac"
    - $ref: "#/definitions/tapi.topology.TransferTimingPac"
    - $ref: "#/definitions/tapi.topology.ValidationPac"
    - type: "object"
      properties:
        layer-protocol-name:
          type: "array"
          description: "none"
          items:
            $ref: "#/definitions/tapi.common.LayerProtocolName"
        resilience-type:
          description: "none"
          $ref: "#/definitions/tapi.topology.ResilienceType"
        node-edge-point:
          type: "array"
          description: "none"
          items:
            $ref: "#/definitions/tapi.topology.NodeEdgePointRef"
        direction:
          description: "The directionality of the Link.\r\n                Is applicable\
            \ to simple Links where all LinkEnds are BIDIRECTIONAL (the Link will\
            \ be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\r\
            \n                Is not present in more complex cases."
          $ref: "#/definitions/tapi.common.ForwardingDirection"
      description: "The Link object class models effective adjacency between two or\
        \ more ForwardingDomains (FD). "
  tapi.topology.LinkRef:
    allOf:
    - $ref: "#/definitions/tapi.topology.TopologyRef"
    - type: "object"
      properties:
        link-uuid:
          type: "string"
          description: "none"
          x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:link/tapi-topology:uuid"
      description: "none"
  tapi.topology.LinkRefWrapper:
    properties:
      supported-client-link:
        $ref: "#/definitions/tapi.topology.LinkRef"
  tapi.topology.LinkWrapper:
    properties:
      link:
        $ref: "#/definitions/tapi.topology.Link"
  tapi.topology.NetworkTopologyService:
    allOf:
    - $ref: "#/definitions/tapi.common.GlobalClass"
    - type: "object"
      properties:
        topology:
          type: "array"
          description: "none"
          items:
            $ref: "#/definitions/tapi.topology.TopologyRef"
      description: "none"
  tapi.topology.NetworkTopologyServiceWrapper:
    properties:
      nw-topology-service:
        $ref: "#/definitions/tapi.topology.NetworkTopologyService"
  tapi.topology.Node:
    allOf:
    - $ref: "#/definitions/tapi.common.AdminStatePac"
    - $ref: "#/definitions/tapi.common.CapacityPac"
    - $ref: "#/definitions/tapi.common.GlobalClass"
    - $ref: "#/definitions/tapi.topology.TransferCostPac"
    - $ref: "#/definitions/tapi.topology.TransferIntegrityPac"
    - $ref: "#/definitions/tapi.topology.TransferTimingPac"
    - type: "object"
      properties:
        layer-protocol-name:
          type: "array"
          description: "none"
          items:
            $ref: "#/definitions/tapi.common.LayerProtocolName"
        encap-topology:
          description: "none"
          $ref: "#/definitions/tapi.topology.TopologyRef"
        owned-node-edge-point:
          type: "array"
          description: "none"
          items:
            $ref: "#/definitions/tapi.topology.NodeEdgePoint"
        node-rule-group:
          type: "array"
          description: "none"
          items:
            $ref: "#/definitions/tapi.topology.NodeRuleGroup"
        aggregated-node-edge-point:
          type: "array"
          description: "none"
          items:
            $ref: "#/definitions/tapi.topology.NodeEdgePointRef"
      description: "The ForwardingDomain (FD) object class models the ForwardingDomain\
        \ topological component which is used to effect forwarding of transport characteristic\
        \ information and offers the potential to enable forwarding.\r\n         \
        \   At the lowest level of recursion, an FD (within a network element (NE))\
        \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\
        \ multiple switch matrices (FDs). "
  tapi.topology.NodeEdgePoint:
    allOf:
    - $ref: "#/definitions/tapi.common.AdminStatePac"
    - $ref: "#/definitions/tapi.common.CapacityPac"
    - $ref: "#/definitions/tapi.common.GlobalClass"
    - $ref: "#/definitions/tapi.common.TerminationPac"
    - type: "object"
      properties:
        link-port-role:
          description: "Each LinkEnd of the Link has a role (e.g., symmetric, hub,\
            \ spoke, leaf, root)  in the context of the Link with respect to the Link\
            \ function. "
          $ref: "#/definitions/tapi.common.PortRole"
        mapped-service-interface-point:
          type: "array"
          description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\
            \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load\
            \ balancing/Resilience) should be considered experimental"
          items:
            $ref: "#/definitions/tapi.common.ServiceInterfacePointRef"
        aggregated-node-edge-point:
          type: "array"
          description: "none"
          items:
            $ref: "#/definitions/tapi.topology.NodeEdgePointRef"
        layer-protocol-name:
          description: "none"
          $ref: "#/definitions/tapi.common.LayerProtocolName"
        link-port-direction:
          description: "The orientation of defined flow at the LinkEnd."
          $ref: "#/definitions/tapi.common.PortDirection"
        supported-cep-layer-protocol-qualifier:
          type: "array"
          description: "none"
          items:
            type: "string"
      description: "The LogicalTerminationPoint (LTP) object class encapsulates the\
        \ termination and adaptation functions of one or more transport layers.\r\n\
        \            The structure of LTP supports all transport protocols including\
        \ circuit and packet forms."
  tapi.topology.NodeEdgePointRef:
    allOf:
    - $ref: "#/definitions/tapi.topology.NodeRef"
    - type: "object"
      properties:
        node-edge-point-uuid:
          type: "string"
          description: "none"
          x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-topology:uuid"
      description: "none"
  tapi.topology.NodeEdgePointRefWrapper:
    properties:
      node-edge-point:
        $ref: "#/definitions/tapi.topology.NodeEdgePointRef"
  tapi.topology.NodeRef:
    allOf:
    - $ref: "#/definitions/tapi.topology.TopologyRef"
    - type: "object"
      properties:
        node-uuid:
          type: "string"
          description: "none"
          x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:uuid"
      description: "none"
  tapi.topology.NodeRuleGroup:
    allOf:
    - $ref: "#/definitions/tapi.common.CapacityPac"
    - $ref: "#/definitions/tapi.common.GlobalClass"
    - $ref: "#/definitions/tapi.topology.RiskParameterPac"
    - $ref: "#/definitions/tapi.topology.TransferCostPac"
    - $ref: "#/definitions/tapi.topology.TransferTimingPac"
    - type: "object"
      properties:
        inter-rule-group:
          type: "array"
          description: "Nested NodeRuleGroups may have InterRuleGroups. The Superior\
            \ NodeRuleGroup contains the nested NodeRuleGroups and their associated\
            \ InterRuleGroups.\r\n                This is equivalent to the Node-Topology\
            \ hierarchy."
          items:
            $ref: "#/definitions/tapi.topology.InterRuleGroup"
        rule:
          type: "array"
          description: "The list of rules of the NodeRuleGroup."
          items:
            $ref: "#/definitions/tapi.topology.Rule"
        node-rule-group:
          type: "array"
          description: "NodeRuleGroups may be nested such that finer grained rules\
            \ may be applied.\r\n                A nested rule group should have a\
            \ subset of the NEPs of the superior rule group."
          items:
            $ref: "#/definitions/tapi.topology.NodeRuleGroupRef"
        node-edge-point:
          type: "array"
          description: "NEPs and their client CEPs that the rules apply to."
          items:
            $ref: "#/definitions/tapi.topology.NodeEdgePointRef"
      description: "Rules that apply to a group of NEPs.\r\n            "
  tapi.topology.NodeRuleGroupRef:
    allOf:
    - $ref: "#/definitions/tapi.topology.NodeRef"
    - type: "object"
      properties:
        node-rule-group-uuid:
          type: "string"
          description: "none"
          x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-rule-group/tapi-topology:uuid"
      description: "none"
  tapi.topology.NodeRuleGroupRefWrapper:
    properties:
      associated-node-rule-group:
        $ref: "#/definitions/tapi.topology.NodeRuleGroupRef"
  tapi.topology.NodeRuleGroupWrapper:
    properties:
      node-rule-group:
        $ref: "#/definitions/tapi.topology.NodeRuleGroup"
  tapi.topology.PortRoleRule:
    type: "object"
    properties:
      port-role-rule:
        type: "array"
        description: "Where the rule references more than one port role or where there\
          \ are rule intersections either as a result of overlay of rules or inter\
          \ rule group usage indicates role matching criteria for a connection following\
          \ the rules.\r\n                For example if two port roles, 'a' and 'b',\
          \ are listed and the port role rule is 'different', this means that a connection\
          \ connecting points in that group must have port roles that are different\
          \ for each CEP in that group.\r\n                In the example if a connection\
          \ can have n ports of role 'a' and m ports of role 'b' then a maximum of\
          \ two ports can be drawn from the NEPs of the group and where there are\
          \ two, one must be role 'a' and one must be role 'b'."
        items:
          type: "string"
      port-role:
        type: "array"
        description: "The role(s) of the port(s) considered in the rule."
        items:
          type: "string"
  tapi.topology.PortRoleRuleWrapper:
    properties:
      cep-port-role:
        $ref: "#/definitions/tapi.topology.PortRoleRule"
  tapi.topology.ProtectionType:
    type: "string"
    enum:
    - "NO_PROTECTON"
    - "ONE_PLUS_ONE_PROTECTION"
    - "ONE_PLUS_ONE_PROTECTION_WITH_DYNAMIC_RESTORATION"
    - "PERMANENT_ONE_PLUS_ONE_PROTECTION"
    - "ONE_FOR_ONE_PROTECTION"
    - "DYNAMIC_RESTORATION"
    - "PRE_COMPUTED_RESTORATION"
    - "ONE_PLUS_ONE_PROTECTION_WITH_PRE_COMPUTED_RESTORATION"
  tapi.topology.ResilienceType:
    type: "object"
    properties:
      restoration-policy:
        description: "none"
        $ref: "#/definitions/tapi.topology.RestorationPolicy"
      protection-type:
        description: "none"
        $ref: "#/definitions/tapi.topology.ProtectionType"
  tapi.topology.ResilienceTypeWrapper:
    properties:
      resilience-type:
        $ref: "#/definitions/tapi.topology.ResilienceType"
  tapi.topology.RestorationPolicy:
    type: "string"
    enum:
    - "PER_DOMAIN_RESTORATION"
    - "END_TO_END_RESTORATION"
    - "NA"
  tapi.topology.RiskCharacteristic:
    type: "object"
    properties:
      risk-characteristic-name:
        type: "string"
        description: "The name of the risk characteristic. The characteristic may\
          \ be related to a specific degree of closeness.\r\n                For example\
          \ a particular characteristic may apply to failures that are localized (e.g.\
          \ to one side of a road) where as another characteristic may relate to failures\
          \ that have a broader impact (e.g. both sides of a road that crosses a bridge).\r\
          \n                Depending upon the importance of the traffic being routed\
          \ different risk characteristics will be evaluated."
      risk-identifier-list:
        type: "array"
        description: "A list of the identifiers of each physical/geographic unit (with\
          \ the specific risk characteristic) that is related to a segment of the\
          \ TopologicalEntity."
        items:
          type: "string"
  tapi.topology.RiskCharacteristicWrapper:
    properties:
      risk-diversity-characteristic:
        $ref: "#/definitions/tapi.topology.RiskCharacteristic"
  tapi.topology.RiskParameterPac:
    type: "object"
    properties:
      risk-characteristic:
        type: "array"
        description: "A list of risk characteristics for consideration in an analysis\
          \ of shared risk. Each element of the list represents a specific risk consideration."
        items:
          $ref: "#/definitions/tapi.topology.RiskCharacteristic"
  tapi.topology.Rule:
    allOf:
    - $ref: "#/definitions/tapi.common.LocalClass"
    - type: "object"
      properties:
        complex-rule:
          type: "array"
          description: "Allows for more complex rules where the basic rule system\
            \ is not sufficient."
          items:
            type: "string"
        rule-type:
          description: "The focus of the rule."
          $ref: "#/definitions/tapi.topology.RuleType"
        signal-property:
          description: "The rule only applies to signals with the properties listed.\
            \ \r\n                If the attribute is not present then the rule applies\
            \ to all signals."
          $ref: "#/definitions/tapi.topology.SignalPropertyRule"
        connection-spec-reference:
          type: "array"
          description: "Identifies the type of connection that the rule applies to.\
            \ \r\n                If the attribute is not present then the rule applies\
            \ to all types of connection supported by the device."
          items:
            $ref: "#/definitions/tapi.topology.ConnectionSpecReference"
        cep-port-role:
          type: "array"
          description: "Indicates the port role to which the rule applies. \r\n  \
            \              The port role is interpreted in the context of the connection\
            \ type which is identified by the connection spec. \r\n              \
            \  The port role is not meaningful in the absence of a connection spec\
            \ reference.\r\n                If a node rule group carries a port role,\
            \ that role applies also to the associated inter rule where the combination\
            \ of the roles in the node rule groups at the ends of the inter group\
            \ rule define the connection orientation.\r\n                For example\
            \ a root-and-leaf connection may be used in a node where a node rule group\
            \ collects one set of NEPs has the port role 'root' and another node rule\
            \ group collects another set of NEPs has the port role 'leaf' where these\
            \ are joined by an inter rule group. This combination specifies an allowed\
            \ orientation of the root-and-leaf connection.\r\n                No port\
            \ role statement means all port roles are allowed."
          items:
            $ref: "#/definitions/tapi.topology.PortRoleRule"
        cep-direction:
          type: "array"
          description: "cep direction is a list of port directions that the rule applies\
            \ to.\r\n                No entry means all cep directions."
          items:
            $ref: "#/definitions/tapi.common.PortDirection"
        override-priority:
          type: "integer"
          format: "int32"
          description: "The overridePriority allows for one rule in a rule group to\
            \ override another.\r\n                Priority n rules override priority\
            \ n+1 rules.\r\n                Rules of the same priority override as\
            \ follows (n overrides n+1):\r\n                1 - MustNot\r\n      \
            \          2 - Must\r\n                3 - May\r\n                4 -\
            \ Null\r\n                Within a rule the flexibility rules (signal,\
            \ port role...) override as follows (n overriedes n+1):\r\n          \
            \      1 - Any\r\n                2 - Same\r\n                3 - Different\r\
            \n                Where there are two or more 'Same' rules, they will\
            \ form an intersection where all must be met.\r\n                "
        layer-protocol-qualifier:
          type: "array"
          description: "Qualifies a rule for a particular layerProtocol identifying\
            \ the qualifiers that the rule apples to.\r\n                If the attribute\
            \ is not present then the rule applies to all relevant qualifiers of the\
            \ layer protocol of the parent entity."
          items:
            type: "string"
        forwarding-rule:
          description: "Rule that restricts the creation/deletion of a Connection\
            \ between points in the node rule group or related by the inter rule group\
            \ between node rule groups."
          $ref: "#/definitions/tapi.topology.ForwardingRule"
      description: "Single complex rule statememt.\r\n            A Node with no rule\
        \ group has no restrictions and is essentially May/Any\r\n            A node\
        \ rule group constrain the CEP connectability in the Node.\r\n           \
        \ A connection from a NEP must abide by all rules that relate to that NEP\r\
        \n            Rules that are for a particular layerProtocolQualifier, connectionSpecReference,\
        \ cepPortRole and cepDirection combination must be abided by in combination\
        \ as dictated by overridePriority.\r\n            If a particular\r\n    \
        \        - connectionSpecReference does not have any rule statements then\
        \ it is not supported and connections of that type are not possible within\
        \ the rule group.\r\n            - cepPortRole of a particular connectionSpecReference\
        \ does not have any rule statements then it is not supported and connections\
        \ of that connectionSpecReference (type) cannot have that cepPortRole for\
        \ CEPs from NEPs in that rule group.\r\n            - cepDirection for a particular\
        \ connectionSpecReference does not have any rule statements then it is not\
        \ supported and connections of that connectionSpecReference (type) cannot\
        \ have that cepPortDirection for CEPs from NEPs in that rule group.\r\n  \
        \          Rules that are for different layerProtocolQualifiers or connectionSpecReferences\
        \ are independent and provide options for connection in the rule group.\r\n\
        \            Some rules may apply to multiple connectionSpecReferences and\
        \ all cepPortRoles and all cepDirections."
  tapi.topology.RuleType:
    type: "string"
    enum:
    - "FORWARDING"
    - "CAPACITY"
    - "COST"
    - "TIMING"
    - "RISK"
    - "GROUPING"
  tapi.topology.RuleWrapper:
    properties:
      rule:
        $ref: "#/definitions/tapi.topology.Rule"
  tapi.topology.SignalPropertyRule:
    type: "object"
    properties:
      number-of-signal-values:
        type: "integer"
        format: "int32"
        description: "The number of instances of this specific property that can be\
          \ supported by the group."
      applicable-signal-value:
        type: "array"
        description: "Specific values of the signal property to which the rule applies."
        items:
          type: "string"
      signal-property-value-rule:
        type: "string"
        description: "Indicates how the signal properties should be accounted for."
      signal-property-name:
        type: "string"
        description: "The name of the signal property to which the rule applies."
  tapi.topology.SignalPropertyRuleWrapper:
    properties:
      signal-property:
        $ref: "#/definitions/tapi.topology.SignalPropertyRule"
  tapi.topology.Topology:
    allOf:
    - $ref: "#/definitions/tapi.common.GlobalClass"
    - type: "object"
      properties:
        layer-protocol-name:
          type: "array"
          description: "none"
          items:
            $ref: "#/definitions/tapi.common.LayerProtocolName"
        link:
          type: "array"
          description: "none"
          items:
            $ref: "#/definitions/tapi.topology.Link"
        node:
          type: "array"
          description: "none"
          items:
            $ref: "#/definitions/tapi.topology.Node"
      description: "The ForwardingDomain (FD) object class models the ForwardingDomain\
        \ topological component which is used to effect forwarding of transport characteristic\
        \ information and offers the potential to enable forwarding. \r\n        \
        \    At the lowest level of recursion, an FD (within a network element (NE))\
        \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\
        \ multiple switch matrices (FDs). "
  tapi.topology.TopologyContext:
    type: "object"
    properties:
      nw-topology-service:
        description: "none"
        $ref: "#/definitions/tapi.topology.NetworkTopologyService"
      topology:
        type: "array"
        description: "none"
        items:
          $ref: "#/definitions/tapi.topology.Topology"
  tapi.topology.TopologyContextWrapper:
    properties:
      tapi-topology:topology-context:
        $ref: "#/definitions/tapi.topology.TopologyContext"
  tapi.topology.TopologyRef:
    type: "object"
    properties:
      topology-uuid:
        type: "string"
        description: "none"
        x-path: "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:uuid"
  tapi.topology.TopologyRefWrapper:
    properties:
      topology:
        $ref: "#/definitions/tapi.topology.TopologyRef"