/TAPI

ONF Transport API Repository (TAPI)

Primary LanguageDApache License 2.0Apache-2.0

This is the release version 2.5.0 of the ONF Transport API (TAPI) SDK. This SDK is being released under the Apache 2.0 license.

The ONF Transport API (TAPI) project charted under the ONF Open Transport Configuration & Control (OTCC) is responsible for the development of this SDK as an Open Source project.

This release includes technology-agnostic interfaces to the following functional modules:

  • Topology Service
  • Connectivity Service
  • Path Computation Service
  • OAM Service
  • Fault Management Service
  • Equipment Inventory Service
  • Virtual Network Service
  • Notification Service
  • Streaming Service
  • gNMI Streaming Service (NEW)

It also includes support for the following technology-specific interface profiles

  • Photonic Media (L0-WDM)
  • Optical Transport Network (L1-OTN)
  • Carrier Ethernet (L2)

The SDK includes the following components:

  • TAPI UML Information Model - The TAPI UML models included in this TAPI release (v2.5.0) are a normative part of the TAPI SDK and are the only source for subsequent generated TAPI SDK components (YANG, OAS, etc.).

    • These models are pruned/refactored from the ONF Core Information Model
    • Some of the UML model artifacts (e.g., Classes, Attributes, Types) that the TAPI contributors consider to be evolving are marked as experimental using the UML OpenModelProfile stereotypes. These artifacts could either become mature or change/evolve in future releases.
    • https://github.com/OpenNetworkingFoundation/TAPI/tree/develop/UmlDumpFiles: Dump of the UML models in Microsoft Word format, generated through Eclipse Gendoc tool.

  • TAPI YANG Schema - The TAPI YANG models included in this TAPI release (v2.5.0) are a normative part of the TAPI SDK.

    • The YANG specifications have been generated from the corresponding UML model using the ONF EAGLE UML2YANG mapping tool ("Tapi_v2x" branch) and further edited manually to comply with the ONF IISOMI UML2YANG mapping guidelines.
    • Status of YANG model artifacts can be determined by referring to the corresponding UML artifacts. As described in the UML models, some artifacts are considered experimental, and thus are the corresponding YANG artifacts.
    • The ONF TAPI release process does not guarantee backward compatibility of YANG models across major versions of TAPI releases. The YANG model backward compatibility criteria are outlined in section 11 of (https://tools.ietf.org/html/rfc7950).

  • TAPI OpenAPI Specification - TAPI OAS (OpenAPI Specifications) included in this TAPI release (v2.5.0) are an informative part of the TAPI SDK.

    • The OAS have been generated from the YANG data models included in this release using the ONF EAGLE YANG2OAS tool following the RESTConf protocol specification (https://tools.ietf.org/html/rfc8040). This specification makes no assessment as to the level of RESTConf compliance of the TAPI REST APIs.

  • TAPI Reference Implementation Agreement (RIA TR-547 3.1)

    • This ONF Technical Recommendation (TR) provides a set of guidelines and recommendations for a standard use of the TAPI models in combination with the RESTCONF protocol for the implementation of the interface between network systems in charge of the control/management of networks based on WDM/OTN technologies.

  • TAPI Reference Implementation Agreement for Streaming (RIA TR-548 3.1)

    • This document is a supplement to the TR-547, to explain TAPI streaming and provide a set of guidelines and recommendations for use of TAPI streaming.

The Reference Implementation Agreements are supported by two associated documents:

As the most deployed release of TAPI at this point is TAPI 2.1.3 a detailed differences between 2.1.3 and 2.5.0 can be obtained using

See also changelog

HighLevelDiff Tapi2.1.3To2.5.0.pdf highlights the key changes from 2.1.3 to 2.5.0