tapi-connectivity.yaml

  tapi.topology.TopologyWrapper:
    properties:
      topology:
        $ref: "#/definitions/tapi.topology.Topology"
  tapi.topology.TransferCostPac:
    type: "object"
    properties:
      cost-characteristic:
        type: "array"
        description: "The list of costs where each cost relates to some aspect of\
          \ the TopologicalEntity."
        items:
          $ref: "#/definitions/tapi.topology.CostCharacteristic"
  tapi.topology.TransferIntegrityPac:
    type: "object"
    properties:
      error-characteristic:
        type: "string"
        description: "Describes the degree to which the signal propagated can be errored.\r\
          \n                Applies to TDM systems as the errored signal will be propagated\
          \ and not packet as errored packets will be discarded."
      unavailable-time-characteristic:
        type: "string"
        description: "Describes the duration for which there may be no valid signal\
          \ propagated."
      server-integrity-process-characteristic:
        type: "string"
        description: "Describes the effect of any server integrity enhancement process\
          \ on the characteristics of the TopologicalEntity."
      delivery-order-characteristic:
        type: "string"
        description: "Describes the degree to which packets will be delivered out\
          \ of sequence.\r\n                Does not apply to TDM as the TDM protocols\
          \ maintain strict order."
      repeat-delivery-characteristic:
        type: "string"
        description: "Primarily applies to packet systems where a packet may be delivered\
          \ more than once (in fault recovery for example).\r\n                It\
          \ can also apply to TDM where several frames may be received twice due to\
          \ switching in a system with a large differential propagation delay."
      loss-characteristic:
        type: "string"
        description: "Describes the acceptable characteristic of lost packets where\
          \ loss may result from discard due to errors or overflow.\r\n          \
          \      Applies to packet systems and not TDM (as for TDM errored signals\
          \ are propagated unless grossly errored and overflow/underflow turns into\
          \ timing slips)."
  tapi.topology.TransferTimingPac:
    type: "object"
    properties:
      latency-characteristic:
        type: "array"
        description: "The effect on the latency of a queuing process. This only has\
          \ significant effect for packet based systems and has a complex characteristic."
        items:
          $ref: "#/definitions/tapi.topology.LatencyCharacteristic"
  tapi.topology.ValidationMechanism:
    type: "object"
    properties:
      layer-protocol-adjacency-validated:
        type: "string"
        description: "State of validatiion"
      validation-mechanism:
        type: "string"
        description: "Name of mechanism used to validate adjacency"
      validation-robustness:
        type: "string"
        description: "Quality of validation (i.e. how likely is the stated validation\
          \ to be invalid)"
  tapi.topology.ValidationMechanismWrapper:
    properties:
      validation-mechanism:
        $ref: "#/definitions/tapi.topology.ValidationMechanism"
  tapi.topology.ValidationPac:
    type: "object"
    properties:
      validation-mechanism:
        type: "array"
        description: "Provides details of the specific validation mechanism(s) used\
          \ to confirm the presence of an intended topologicalEntity."
        items:
          $ref: "#/definitions/tapi.topology.ValidationMechanism"
  tapi.topology.getlinkdetails.Input:
    type: "object"
    properties:
      link-id-or-name:
        type: "string"
        description: "none"
      topology-id-or-name:
        type: "string"
        description: "none"
  tapi.topology.getlinkdetails.Output:
    type: "object"
    properties:
      link:
        description: "none"
        $ref: "#/definitions/tapi.topology.Link"
  tapi.topology.getnodedetails.Input:
    type: "object"
    properties:
      node-id-or-name:
        type: "string"
        description: "none"
      topology-id-or-name:
        type: "string"
        description: "none"
  tapi.topology.getnodedetails.Output:
    type: "object"
    properties:
      node:
        description: "none"
        $ref: "#/definitions/tapi.topology.Node"
  tapi.topology.getnodeedgepointdetails.Input:
    type: "object"
    properties:
      ep-id-or-name:
        type: "string"
        description: "none"
      node-id-or-name:
        type: "string"
        description: "none"
      topology-id-or-name:
        type: "string"
        description: "none"
  tapi.topology.getnodeedgepointdetails.Output:
    type: "object"
    properties:
      node-edge-point:
        description: "none"
        $ref: "#/definitions/tapi.topology.NodeEdgePoint"
  tapi.topology.gettopologydetails.Input:
    type: "object"
    properties:
      topology-id-or-name:
        type: "string"
        description: "none"
  tapi.topology.gettopologydetails.Output:
    type: "object"
    properties:
      topology:
        description: "none"
        $ref: "#/definitions/tapi.topology.Topology"
  tapi.topology.gettopologylist.Output:
    type: "object"
    properties:
      topology:
        type: "array"
        description: "none"
        items:
          $ref: "#/definitions/tapi.topology.Topology"
  tapi.topology.node.OwnedNodeEdgePoint:
    allOf:
    - $ref: "#/definitions/tapi.connectivity.OwnedNodeEdgePointAugmentation1"
    - $ref: "#/definitions/tapi.topology.NodeEdgePoint"
  tapi.topology.node.OwnedNodeEdgePointWrapper:
    properties:
      owned-node-edge-point:
        $ref: "#/definitions/tapi.topology.node.OwnedNodeEdgePoint"
  tapi.topology.topology.Node:
    allOf:
    - $ref: "#/definitions/tapi.common.AdminStatePac"
    - $ref: "#/definitions/tapi.common.CapacityPac"
    - $ref: "#/definitions/tapi.common.GlobalClass"
    - $ref: "#/definitions/tapi.topology.TransferCostPac"
    - $ref: "#/definitions/tapi.topology.TransferIntegrityPac"
    - $ref: "#/definitions/tapi.topology.TransferTimingPac"
    - type: "object"
      properties:
        layer-protocol-name:
          type: "array"
          description: "none"
          items:
            $ref: "#/definitions/tapi.common.LayerProtocolName"
        encap-topology:
          description: "none"
          $ref: "#/definitions/tapi.topology.TopologyRef"
        owned-node-edge-point:
          type: "array"
          description: "none"
          items:
            $ref: "#/definitions/tapi.topology.node.OwnedNodeEdgePoint"
        node-rule-group:
          type: "array"
          description: "none"
          items:
            $ref: "#/definitions/tapi.topology.NodeRuleGroup"
        aggregated-node-edge-point:
          type: "array"
          description: "none"
          items:
            $ref: "#/definitions/tapi.topology.NodeEdgePointRef"
      description: "none"
  tapi.topology.topology.NodeWrapper:
    properties:
      node:
        $ref: "#/definitions/tapi.topology.topology.Node"