openapi: 3.2.0 info: title: Mef Tapi Topology API version: 2018R2 description: 'Operations tagged tapi-topology across 4 of this provider''s published API definitions: mef-lso-presto-nrp-openapi.yml, mef-lso-presto-nrp-rcp-only-openapi.yml, mef-lso-presto-nrp-rpc-only-simplified-hierarchy-openapi.yml, mef-lso-presto-nrp-simplified-hierarchy-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://localhost:1234/restconf tags: - name: tapi-topology paths: /operations/get-link-details/: post: tags: - tapi-topology responses: 200: description: Correct response content: application/json: schema: $ref: '#/components/schemas/tapi.topology.GetLinkDetailsOutput' application/xml: schema: $ref: '#/components/schemas/tapi.topology.GetLinkDetailsOutput' 201: description: No response 400: description: Internal error requestBody: content: application/json: schema: $ref: '#/components/schemas/tapi.topology.GetLinkDetailsInput' application/xml: schema: $ref: '#/components/schemas/tapi.topology.GetLinkDetailsInput' servers: - url: https://localhost:1234/restconf /operations/get-node-details/: post: tags: - tapi-topology responses: 200: description: Correct response content: application/json: schema: $ref: '#/components/schemas/tapi.topology.GetNodeDetailsOutput' application/xml: schema: $ref: '#/components/schemas/tapi.topology.GetNodeDetailsOutput' 201: description: No response 400: description: Internal error requestBody: content: application/json: schema: $ref: '#/components/schemas/tapi.topology.GetNodeDetailsInput' application/xml: schema: $ref: '#/components/schemas/tapi.topology.GetNodeDetailsInput' servers: - url: https://localhost:1234/restconf /operations/get-node-edge-point-details/: post: tags: - tapi-topology responses: 200: description: Correct response content: application/json: schema: $ref: '#/components/schemas/tapi.topology.GetNodeEdgePointDetailsOutput' application/xml: schema: $ref: '#/components/schemas/tapi.topology.GetNodeEdgePointDetailsOutput' 201: description: No response 400: description: Internal error requestBody: content: application/json: schema: $ref: '#/components/schemas/tapi.topology.GetNodeEdgePointDetailsInput' application/xml: schema: $ref: '#/components/schemas/tapi.topology.GetNodeEdgePointDetailsInput' servers: - url: https://localhost:1234/restconf /operations/get-topology-details/: post: tags: - tapi-topology responses: 200: description: Correct response content: application/json: schema: $ref: '#/components/schemas/tapi.topology.GetTopologyDetailsOutput' application/xml: schema: $ref: '#/components/schemas/tapi.topology.GetTopologyDetailsOutput' 201: description: No response 400: description: Internal error requestBody: content: application/json: schema: $ref: '#/components/schemas/tapi.topology.GetTopologyDetailsInput' application/xml: schema: $ref: '#/components/schemas/tapi.topology.GetTopologyDetailsInput' servers: - url: https://localhost:1234/restconf /operations/get-topology-list/: post: tags: - tapi-topology responses: 200: description: Correct response content: application/json: schema: $ref: '#/components/schemas/tapi.topology.GetTopologyListOutput' application/xml: schema: $ref: '#/components/schemas/tapi.topology.GetTopologyListOutput' 201: description: No response 400: description: Internal error servers: - url: https://localhost:1234/restconf components: schemas: 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: '#/components/schemas/tapi.topology.ValidationMechanism' tapi.topology.NodeRuleGroupRef: allOf: - $ref: '#/components/schemas/tapi.topology.NodeRef' - type: object properties: node-rule-group-id: type: string x-path: /tapi-common:context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-rule-group/tapi-topology:uuid tapi.topology.GetNodeEdgePointDetailsOutput: properties: output: type: object properties: node-edge-point: description: none $ref: '#/components/schemas/tapi.topology.NodeEdgePoint' 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.GetTopologyDetailsInput: properties: input: type: object properties: topology-id-or-name: type: string description: none tapi.topology.GetNodeEdgePointDetailsInput: properties: 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.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: '#/components/schemas/tapi.topology.RiskCharacteristic' tapi.common.PortRole: type: string enum: - SYMMETRIC - ROOT - LEAF - TRUNK - UNKNOWN tapi.topology.OwnedNodeEdgePointRef: allOf: - $ref: '#/components/schemas/tapi.topology.NodeRef' - type: object properties: owned-node-edge-point-id: type: string x-path: /tapi-common:context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-topology:uuid tapi.common.AdministrativeState: type: string enum: - LOCKED - UNLOCKED tapi.topology.GetTopologyListOutput: properties: output: type: object properties: topology: type: array description: none items: $ref: '#/components/schemas/tapi.topology.Topology' tapi.common.TerminationPac: type: object properties: termination-direction: description: "The overall directionality of the LP. \n - A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\n - A SINK LP can only contain elements with SINK flows or CONTRA_DIRECTION_SOURCE flows\n - A SOURCE LP can only contain SOURCE flows or CONTRA_DIRECTION_SINK flows" $ref: '#/components/schemas/tapi.common.TerminationDirection' termination-state: description: Indicates whether the layer is terminated and if so how. $ref: '#/components/schemas/tapi.common.TerminationState' tapi.topology.GetLinkDetailsInput: properties: input: type: object properties: link-id-or-name: type: string description: none topology-id-or-name: type: string description: none tapi.topology.GetNodeDetailsOutput: properties: output: type: object properties: node: description: none $ref: '#/components/schemas/tapi.topology.Node' tapi.common.CapacityPac: type: object properties: available-capacity: description: Capacity available to be assigned. $ref: '#/components/schemas/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: '#/components/schemas/tapi.common.Capacity' tapi.topology.GetNodeDetailsInput: properties: input: type: object properties: node-id-or-name: type: string description: none topology-id-or-name: type: string description: none tapi.common.PortDirection: type: string enum: - BIDIRECTIONAL - INPUT - OUTPUT - UNIDENTIFIED_OR_UNKNOWN tapi.common.OperationalState: type: string enum: - DISABLED - ENABLED tapi.common.BandwidthProfileType: type: string enum: - MEF_10.x - RFC_2697 - RFC_2698 - RFC_4115 tapi.topology.GetTopologyDetailsOutput: properties: output: type: object properties: topology: description: none $ref: '#/components/schemas/tapi.topology.Topology' 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.\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.\n Applies to TDM systems (and not packet)." queing-latency-characteristic: type: string description: The specific queuing latency for the traffic property. tapi.topology.NodeRef: allOf: - $ref: '#/components/schemas/tapi.topology.TopologyRef' - type: object properties: node-id: type: string x-path: /tapi-common:context/tapi-topology:topology/tapi-topology:node/tapi-topology:uuid tapi.topology.Topology: allOf: - $ref: '#/components/schemas/tapi.common.GlobalClass' - type: object properties: layer-protocol-name: type: array description: none items: $ref: '#/components/schemas/tapi.common.LayerProtocolName' link: type: array description: none items: $ref: '#/components/schemas/tapi.topology.Link' node: type: array description: none items: $ref: '#/components/schemas/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.\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.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.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.RuleType: type: string enum: - FORWARDING - CAPACITY - COST - TIMING - RISK - GROUPING tapi.topology.Link: allOf: - $ref: '#/components/schemas/tapi.common.AdminStatePac' - $ref: '#/components/schemas/tapi.common.CapacityPac' - $ref: '#/components/schemas/tapi.common.GlobalClass' - $ref: '#/components/schemas/tapi.topology.LayerProtocolTransitionPac' - $ref: '#/components/schemas/tapi.topology.RiskParameterPac' - $ref: '#/components/schemas/tapi.topology.TransferCostPac' - $ref: '#/components/schemas/tapi.topology.TransferIntegrityPac' - $ref: '#/components/schemas/tapi.topology.TransferTimingPac' - $ref: '#/components/schemas/tapi.topology.ValidationPac' - type: object properties: layer-protocol-name: type: array description: none items: $ref: '#/components/schemas/tapi.common.LayerProtocolName' resilience-type: description: none $ref: '#/components/schemas/tapi.topology.ResilienceType' node-edge-point: type: array description: none items: $ref: '#/components/schemas/tapi.topology.OwnedNodeEdgePointRef' direction: description: "The directionality of the Link.\n Is applicable to simple Links where all LinkEnds are BIDIRECTIONAL (the Link will be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\n Is not present in more complex cases." $ref: '#/components/schemas/tapi.common.ForwardingDirection' description: 'The Link object class models effective adjacency between two or more ForwardingDomains (FD). ' tapi.common.ForwardingDirection: type: string enum: - BIDIRECTIONAL - UNIDIRECTIONAL - UNDEFINED_OR_UNKNOWN tapi.topology.NodeEdgePoint: allOf: - $ref: '#/components/schemas/tapi.common.AdminStatePac' - $ref: '#/components/schemas/tapi.common.CapacityPac' - $ref: '#/components/schemas/tapi.common.GlobalClass' - $ref: '#/components/schemas/tapi.common.TerminationPac' - type: object properties: layer-protocol-name: description: none $ref: '#/components/schemas/tapi.common.LayerProtocolName' 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: '#/components/schemas/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: '#/components/schemas/tapi.common.ServiceInterfacePointRef' link-port-direction: description: The orientation of defined flow at the LinkEnd. $ref: '#/components/schemas/tapi.common.PortDirection' aggregated-node-edge-point: type: array description: none items: type: string x-path: /tapi-common:context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-topology:uuid description: "The LogicalTerminationPoint (LTP) object class encapsulates the termination and adaptation functions of one or more transport layers.\n The structure of LTP supports all transport protocols including circuit and packet forms." 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.ServiceInterfacePointRef: type: object properties: service-interface-point-id: type: string x-path: /tapi-common:context/tapi-common:service-interface-point/tapi-common:uuid tapi.common.CapacityValue: type: object properties: value: type: integer format: int32 description: none unit: description: none $ref: '#/components/schemas/tapi.common.CapacityUnit' tapi.common.LifecycleState: type: string enum: - PLANNED - POTENTIAL_AVAILABLE - POTENTIAL_BUSY - INSTALLED - PENDING_REMOVAL 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.Node: allOf: - $ref: '#/components/schemas/tapi.common.AdminStatePac' - $ref: '#/components/schemas/tapi.common.CapacityPac' - $ref: '#/components/schemas/tapi.common.GlobalClass' - $ref: '#/components/schemas/tapi.topology.TransferCostPac' - $ref: '#/components/schemas/tapi.topology.TransferIntegrityPac' - $ref: '#/components/schemas/tapi.topology.TransferTimingPac' - type: object properties: layer-protocol-name: type: array description: none items: $ref: '#/components/schemas/tapi.common.LayerProtocolName' encap-topology: description: none $ref: '#/components/schemas/tapi.topology.TopologyRef' owned-node-edge-point: type: array description: none items: $ref: '#/components/schemas/tapi.topology.NodeEdgePoint' node-rule-group: type: array description: none items: $ref: '#/components/schemas/tapi.topology.NodeRuleGroup' aggregated-node-edge-point: type: array description: none items: type: string x-path: /tapi-common:context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-topology:uuid 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.\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.TopologyRef: type: object properties: topology-id: type: string x-path: /tapi-common:context/tapi-topology:topology/tapi-topology:uuid 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. \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).\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.NodeRuleGroup: allOf: - $ref: '#/components/schemas/tapi.common.CapacityPac' - $ref: '#/components/schemas/tapi.common.GlobalClass' - $ref: '#/components/schemas/tapi.topology.RiskParameterPac' - $ref: '#/components/schemas/tapi.topology.TransferCostPac' - $ref: '#/components/schemas/tapi.topology.TransferTimingPac' - type: object properties: inter-rule-group: type: array description: none items: $ref: '#/components/schemas/tapi.topology.InterRuleGroup' rule: type: array description: none items: $ref: '#/components/schemas/tapi.topology.Rule' node-rule-group: type: array description: none items: $ref: '#/components/schemas/tapi.topology.NodeRuleGroupRef' node-edge-point: type: array description: none items: type: string x-path: /tapi-common:context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-topology:uuid description: none tapi.common.Capacity: type: object properties: bandwidth-profile: description: none $ref: '#/components/schemas/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: '#/components/schemas/tapi.common.CapacityValue' tapi.topology.InterRuleGroup: allOf: - $ref: '#/components/schemas/tapi.common.CapacityPac' - $ref: '#/components/schemas/tapi.common.GlobalClass' - $ref: '#/components/schemas/tapi.topology.RiskParameterPac' - $ref: '#/components/schemas/tapi.topology.TransferCostPac' - $ref: '#/components/schemas/tapi.topology.TransferTimingPac' - type: object properties: associated-node-rule-group: type: array description: none items: $ref: '#/components/schemas/tapi.topology.NodeRuleGroupRef' rule: type: array description: none items: $ref: '#/components/schemas/tapi.topology.Rule' description: none 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.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: '#/components/schemas/tapi.topology.LatencyCharacteristic' 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: '#/components/schemas/tapi.topology.CostCharacteristic' tapi.common.AdminStatePac: type: object properties: operational-state: description: none $ref: '#/components/schemas/tapi.common.OperationalState' lifecycle-state: description: none $ref: '#/components/schemas/tapi.common.LifecycleState' administrative-state: description: none $ref: '#/components/schemas/tapi.common.AdministrativeState' tapi.topology.RestorationPolicy: type: string enum: - PER_DOMAIN_RESTORATION - END_TO_END_RESTORATION - NA tapi.common.BandwidthProfile: type: object properties: committed-information-rate: description: none $ref: '#/components/schemas/tapi.common.CapacityValue' coupling-flag: type: boolean description: none default: false bw-profile-type: description: none $ref: '#/components/schemas/tapi.common.BandwidthProfileType' peak-information-rate: description: none $ref: '#/components/schemas/tapi.common.CapacityValue' committed-burst-size: description: none $ref: '#/components/schemas/tapi.common.CapacityValue' peak-burst-size: description: none $ref: '#/components/schemas/tapi.common.CapacityValue' color-aware: type: boolean description: none default: false 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: '#/components/schemas/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.\n UUID here uses string representation as defined in RFC 4122. The canonical representation uses lowercase characters.\n Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \n Example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.topology.ForwardingRule: type: string enum: - MAY_FORWARD_ACROSS_GROUP - MUST_FORWARD_ACROSS_GROUP - CANNOT_FORWARD_ACROSS_GROUP - NO_STATEMENT_ON_FORWARDING tapi.topology.GetLinkDetailsOutput: properties: output: type: object properties: link: description: none $ref: '#/components/schemas/tapi.topology.Link' tapi.topology.Rule: allOf: - $ref: '#/components/schemas/tapi.common.LocalClass' - type: object properties: override-priority: type: integer format: int32 description: none forwarding-rule: description: none $ref: '#/components/schemas/tapi.topology.ForwardingRule' rule-type: description: none $ref: '#/components/schemas/tapi.topology.RuleType' description: none tapi.topology.TransferIntegrityPac: type: object properties: error-characteristic: type: string description: "Describes the degree to which the signal propagated can be errored.\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.\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).\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.\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.common.LayerProtocolName: type: string enum: - OTSiA - OCH - OTU - ODU - ETH - ETY - DSR 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: '#/components/schemas/tapi.common.NameAndValue' local-id: type: string description: none tapi.common.CapacityUnit: type: string enum: - TB - TBPS - GB - GBPS - MB - MBPS - KB - KBPS tapi.topology.ResilienceType: type: object properties: restoration-policy: description: none $ref: '#/components/schemas/tapi.topology.RestorationPolicy' protection-type: description: none $ref: '#/components/schemas/tapi.topology.ProtectionType' tapi.common.TerminationDirection: type: string enum: - BIDIRECTIONAL - SINK - SOURCE - UNDEFINED_OR_UNKNOWN tapi.topology.TransferIntegrityPac_2: type: object properties: error-characteristic: type: string description: "Describes the degree to which the signal propagated can be errored.\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.\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).\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.\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.Link_2: allOf: - $ref: '#/components/schemas/tapi.common.GlobalClass' - properties: available-capacity: description: Capacity available to be assigned. $ref: '#/components/schemas/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: '#/components/schemas/tapi.common.Capacity' operational-state: description: none $ref: '#/components/schemas/tapi.common.OperationalState' lifecycle-state: description: none $ref: '#/components/schemas/tapi.common.LifecycleState' administrative-state: description: none $ref: '#/components/schemas/tapi.common.AdministrativeState' 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 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: '#/components/schemas/tapi.topology.LatencyCharacteristic' layer-protocol-name: type: array description: none items: $ref: '#/components/schemas/tapi.common.LayerProtocolName' resilience-type: description: none $ref: '#/components/schemas/tapi.topology.ResilienceType' node-edge-point: type: array description: none items: $ref: '#/components/schemas/tapi.topology.OwnedNodeEdgePointRef' direction: description: "The directionality of the Link.\n Is applicable to simple Links where all LinkEnds are BIDIRECTIONAL (the Link will be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\n Is not present in more complex cases." $ref: '#/components/schemas/tapi.common.ForwardingDirection' error-characteristic: type: string description: "Describes the degree to which the signal propagated can be errored.\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.\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).\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.\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)." cost-characteristic: type: array description: The list of costs where each cost relates to some aspect of the TopologicalEntity. items: $ref: '#/components/schemas/tapi.topology.CostCharacteristic' validation-mechanism: type: array description: Provides details of the specific validation mechanism(s) used to confirm the presence of an intended topologicalEntity. items: $ref: '#/components/schemas/tapi.topology.ValidationMechanism' 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: '#/components/schemas/tapi.topology.RiskCharacteristic' tapi.topology.NodeEdgePoint_2: allOf: - $ref: '#/components/schemas/tapi.common.GlobalClass' - properties: available-capacity: description: Capacity available to be assigned. $ref: '#/components/schemas/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: '#/components/schemas/tapi.common.Capacity' operational-state: description: none $ref: '#/components/schemas/tapi.common.OperationalState' lifecycle-state: description: none $ref: '#/components/schemas/tapi.common.LifecycleState' administrative-state: description: none $ref: '#/components/schemas/tapi.common.AdministrativeState' termination-direction: description: "The overall directionality of the LP. \n - A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\n - A SINK LP can only contain elements with SINK flows or CONTRA_DIRECTION_SOURCE flows\n - A SOURCE LP can only contain SOURCE flows or CONTRA_DIRECTION_SINK flows" $ref: '#/components/schemas/tapi.common.TerminationDirection' termination-state: description: Indicates whether the layer is terminated and if so how. $ref: '#/components/schemas/tapi.common.TerminationState' layer-protocol-name: description: none $ref: '#/components/schemas/tapi.common.LayerProtocolName' 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: '#/components/schemas/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: '#/components/schemas/tapi.common.ServiceInterfacePointRef' link-port-direction: description: The orientation of defined flow at the LinkEnd. $ref: '#/components/schemas/tapi.common.PortDirection' aggregated-node-edge-point: type: array description: none items: type: string x-path: /tapi-common:context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-topology:uuid tapi.topology.Node_2: allOf: - $ref: '#/components/schemas/tapi.common.GlobalClass' - properties: available-capacity: description: Capacity available to be assigned. $ref: '#/components/schemas/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: '#/components/schemas/tapi.common.Capacity' layer-protocol-name: type: array description: none items: $ref: '#/components/schemas/tapi.common.LayerProtocolName' encap-topology: description: none $ref: '#/components/schemas/tapi.topology.TopologyRef' owned-node-edge-point: type: array description: none items: $ref: '#/components/schemas/tapi.topology.NodeEdgePoint_2' node-rule-group: type: array description: none items: $ref: '#/components/schemas/tapi.topology.NodeRuleGroup_2' aggregated-node-edge-point: type: array description: none items: type: string x-path: /tapi-common:context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-topology:uuid operational-state: description: none $ref: '#/components/schemas/tapi.common.OperationalState' lifecycle-state: description: none $ref: '#/components/schemas/tapi.common.LifecycleState' administrative-state: description: none $ref: '#/components/schemas/tapi.common.AdministrativeState' 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: '#/components/schemas/tapi.topology.LatencyCharacteristic' error-characteristic: type: string description: "Describes the degree to which the signal propagated can be errored.\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.\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).\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.\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)." cost-characteristic: type: array description: The list of costs where each cost relates to some aspect of the TopologicalEntity. items: $ref: '#/components/schemas/tapi.topology.CostCharacteristic' tapi.topology.NodeRuleGroup_2: allOf: - $ref: '#/components/schemas/tapi.common.GlobalClass' - properties: available-capacity: description: Capacity available to be assigned. $ref: '#/components/schemas/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: '#/components/schemas/tapi.common.Capacity' inter-rule-group: type: array description: none items: $ref: '#/components/schemas/tapi.topology.InterRuleGroup_2' rule: type: array description: none items: $ref: '#/components/schemas/tapi.topology.Rule' node-rule-group: type: array description: none items: $ref: '#/components/schemas/tapi.topology.NodeRuleGroupRef' node-edge-point: type: array description: none items: type: string x-path: /tapi-common:context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-topology:uuid 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: '#/components/schemas/tapi.topology.LatencyCharacteristic' cost-characteristic: type: array description: The list of costs where each cost relates to some aspect of the TopologicalEntity. items: $ref: '#/components/schemas/tapi.topology.CostCharacteristic' 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: '#/components/schemas/tapi.topology.RiskCharacteristic' tapi.topology.InterRuleGroup_2: allOf: - $ref: '#/components/schemas/tapi.common.GlobalClass' - properties: available-capacity: description: Capacity available to be assigned. $ref: '#/components/schemas/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: '#/components/schemas/tapi.common.Capacity' 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: '#/components/schemas/tapi.topology.LatencyCharacteristic' associated-node-rule-group: type: array description: none items: $ref: '#/components/schemas/tapi.topology.NodeRuleGroupRef' rule: type: array description: none items: $ref: '#/components/schemas/tapi.topology.Rule' cost-characteristic: type: array description: The list of costs where each cost relates to some aspect of the TopologicalEntity. items: $ref: '#/components/schemas/tapi.topology.CostCharacteristic' 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: '#/components/schemas/tapi.topology.RiskCharacteristic' tapi.topology.Link_3: allOf: - $ref: '#/components/schemas/tapi.common.GlobalClass' - properties: available-capacity: description: Capacity available to be assigned. $ref: '#/components/schemas/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: '#/components/schemas/tapi.common.Capacity' operational-state: description: none $ref: '#/components/schemas/tapi.common.OperationalState' lifecycle-state: description: none $ref: '#/components/schemas/tapi.common.LifecycleState' administrative-state: description: none $ref: '#/components/schemas/tapi.common.AdministrativeState' 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 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: '#/components/schemas/tapi.topology.LatencyCharacteristic' layer-protocol-name: type: array description: none items: $ref: '#/components/schemas/tapi.common.LayerProtocolName' resilience-type: description: none $ref: '#/components/schemas/tapi.topology.ResilienceType' node-edge-point: type: array description: none items: $ref: '#/components/schemas/tapi.topology.OwnedNodeEdgePointRef' direction: description: "The directionality of the Link.\n Is applicable to simple Links where all LinkEnds are BIDIRECTIONAL (the Link will be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\n Is not present in more complex cases." $ref: '#/components/schemas/tapi.common.ForwardingDirection' error-characteristic: type: string description: "Describes the degree to which the signal propagated can be errored.\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.\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).\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.\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)." cost-characteristic: type: array description: The list of costs where each cost relates to some aspect of the TopologicalEntity. items: $ref: '#/components/schemas/tapi.topology.CostCharacteristic' validation-mechanism: type: array description: Provides details of the specific validation mechanism(s) used to confirm the presence of an intended topologicalEntity. items: $ref: '#/components/schemas/tapi.topology.ValidationMechanism' 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: '#/components/schemas/tapi.topology.RiskCharacteristic' tapi.topology.NodeEdgePoint_3: allOf: - $ref: '#/components/schemas/tapi.common.GlobalClass' - properties: available-capacity: description: Capacity available to be assigned. $ref: '#/components/schemas/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: '#/components/schemas/tapi.common.Capacity' operational-state: description: none $ref: '#/components/schemas/tapi.common.OperationalState' lifecycle-state: description: none $ref: '#/components/schemas/tapi.common.LifecycleState' administrative-state: description: none $ref: '#/components/schemas/tapi.common.AdministrativeState' layer-protocol-name: description: none $ref: '#/components/schemas/tapi.common.LayerProtocolName' 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: '#/components/schemas/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: '#/components/schemas/tapi.common.ServiceInterfacePointRef' link-port-direction: description: The orientation of defined flow at the LinkEnd. $ref: '#/components/schemas/tapi.common.PortDirection' aggregated-node-edge-point: type: array description: none items: type: string x-path: /tapi-common:context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-topology:uuid termination-direction: description: "The overall directionality of the LP. \n - A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\n - A SINK LP can only contain elements with SINK flows or CONTRA_DIRECTION_SOURCE flows\n - A SOURCE LP can only contain SOURCE flows or CONTRA_DIRECTION_SINK flows" $ref: '#/components/schemas/tapi.common.TerminationDirection' termination-state: description: Indicates whether the layer is terminated and if so how. $ref: '#/components/schemas/tapi.common.TerminationState' tapi.topology.Node_3: allOf: - $ref: '#/components/schemas/tapi.common.GlobalClass' - properties: available-capacity: description: Capacity available to be assigned. $ref: '#/components/schemas/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: '#/components/schemas/tapi.common.Capacity' layer-protocol-name: type: array description: none items: $ref: '#/components/schemas/tapi.common.LayerProtocolName' encap-topology: description: none $ref: '#/components/schemas/tapi.topology.TopologyRef' owned-node-edge-point: type: array description: none items: $ref: '#/components/schemas/tapi.topology.NodeEdgePoint_3' node-rule-group: type: array description: none items: $ref: '#/components/schemas/tapi.topology.NodeRuleGroup_3' aggregated-node-edge-point: type: array description: none items: type: string x-path: /tapi-common:context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-topology:uuid operational-state: description: none $ref: '#/components/schemas/tapi.common.OperationalState' lifecycle-state: description: none $ref: '#/components/schemas/tapi.common.LifecycleState' administrative-state: description: none $ref: '#/components/schemas/tapi.common.AdministrativeState' 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: '#/components/schemas/tapi.topology.LatencyCharacteristic' error-characteristic: type: string description: "Describes the degree to which the signal propagated can be errored.\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.\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).\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.\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)." cost-characteristic: type: array description: The list of costs where each cost relates to some aspect of the TopologicalEntity. items: $ref: '#/components/schemas/tapi.topology.CostCharacteristic' tapi.topology.NodeRuleGroup_3: allOf: - $ref: '#/components/schemas/tapi.common.GlobalClass' - properties: available-capacity: description: Capacity available to be assigned. $ref: '#/components/schemas/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: '#/components/schemas/tapi.common.Capacity' inter-rule-group: type: array description: none items: $ref: '#/components/schemas/tapi.topology.InterRuleGroup_3' rule: type: array description: none items: $ref: '#/components/schemas/tapi.topology.Rule' node-rule-group: type: array description: none items: $ref: '#/components/schemas/tapi.topology.NodeRuleGroupRef' node-edge-point: type: array description: none items: type: string x-path: /tapi-common:context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-topology:uuid 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: '#/components/schemas/tapi.topology.LatencyCharacteristic' cost-characteristic: type: array description: The list of costs where each cost relates to some aspect of the TopologicalEntity. items: $ref: '#/components/schemas/tapi.topology.CostCharacteristic' 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: '#/components/schemas/tapi.topology.RiskCharacteristic' tapi.topology.InterRuleGroup_3: allOf: - $ref: '#/components/schemas/tapi.common.GlobalClass' - properties: available-capacity: description: Capacity available to be assigned. $ref: '#/components/schemas/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: '#/components/schemas/tapi.common.Capacity' 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: '#/components/schemas/tapi.topology.LatencyCharacteristic' associated-node-rule-group: type: array description: none items: $ref: '#/components/schemas/tapi.topology.NodeRuleGroupRef' rule: type: array description: none items: $ref: '#/components/schemas/tapi.topology.Rule' cost-characteristic: type: array description: The list of costs where each cost relates to some aspect of the TopologicalEntity. items: $ref: '#/components/schemas/tapi.topology.CostCharacteristic' 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: '#/components/schemas/tapi.topology.RiskCharacteristic' x-refined-from: - mef-lso-presto-nrp-openapi.yml - mef-lso-presto-nrp-rcp-only-openapi.yml - mef-lso-presto-nrp-rpc-only-simplified-hierarchy-openapi.yml - mef-lso-presto-nrp-simplified-hierarchy-openapi.yml