Releases: Open-Network-Models-and-Interfaces-ONMI/TAPI
Linux Foundation ONMI Project Transport API (TAPI) SDK 2.6.0 Release Candidate 1
This is a pre-release version 2.6.0-RC1 of the Linux Foundation ONMI Project Transport API (TAPI) SDK
This SDK is being released under the Apache 2.0 license.
The LF TAPI project is chartered under the LF Projects. OMNI TAPI 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
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.6.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 (formerly 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.
-
TAPI YANG Schema - The TAPI YANG models included in this TAPI release (v2.6.0) are a normative part of the TAPI SDK.
- The YANG specifications have been generated from the corresponding UML model using the EAGLE UML2YANG mapping tool ("Tapi_v2x" branch) and further edited manually to comply with the 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.6.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.
- Implementations may use other forms of REST APIs but must be based on the YANG models defined in this release and are subject to implementation agreements between concerned parties for interoperability.
ONF Transport API SDK 2.1.4 Release
This is the release version 2.1.4 of the Transport API (TAPI) SDK
This SDK is being released under the Apache 2.0 license.
This release has exactly the same contents of version 2.1.3 of the TAPI SDK, with amended OAS modules.
ONF Transport API SDK 2.5.1 Release
This is the release version 2.5.1 of the Transport API (TAPI) SDK
This SDK is being released under the Apache 2.0 license.
This release has exactly the same contents of version 2.5.0 of the TAPI SDK, plus patches defined in additional YANG modules which augment the 2.5.0 definitions.
ONF Transport API SDK 2.5.0 Release
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.
Warning! Patch version 2.5.1 available
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.
- 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.
- Implementations may use other forms of REST APIs but must be based on the YANG models defined in this release and are subject to implementation agreements between concerned parties for interoperability.
WARNING: The OAS modules included in v2.5.0 have errors, please use the modules in OAS_250_Corrected
-
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:
Guideline for the generation of YANG/TREE/OAS modules from UML model:
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
ONF Transport API SDK 2.5.0 Release Candidate 1
This is a pre-release version 2.5.0-RC1 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/blob/v2.5.0-RC1/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.
- Implementations may use other forms of REST APIs but must be based on the YANG models defined in this release and are subject to implementation agreements between concerned parties for interoperability.
-
TAPI Reference Implementation Agreement (RIA TR-547 3.0)
- 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.0)
- 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
ONF Transport API SDK 2.4.1 Release
This is the release version 2.4.1 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
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.4.1) 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.
- TapiGenDoc_v2.4.1.pdf is the dump of the whole UML model in Microsoft Word format, generated through Eclipse Gendoc tool.
-
TAPI YANG Schema - The TAPI YANG models included in this TAPI release (v2.4.1) 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). YANG models included in this release are backward compatible with previous release 2.4.0.
-
TAPI OpenAPI Specification - TAPI OAS (OpenAPI Specifications) included in this TAPI release (v2.4.1) 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.
- Implementations may use other forms of REST APIs but must be based on the YANG models defined in this release and are subject to implementation agreements between concerned parties for interoperability.
-
TAPI Reference Implementation Agreement (RIA TR-547 2.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 2.0)
- 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 (TAPI RIA 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.4.1 can be obtained using
See also changelog
HighLevelDiff_Tapi2.1.3To2.4.1.pdf highlights the key changes from 2.1.3 to 2.4.1
ONF Transport API SDK 2.4.1 Release Candidate 1
This is a pre-release version 2.4.1-RC1 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
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.4.1) 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.
- TapiGenDoc_v2.4.1.pdf is the dump of the whole UML model in Microsoft Word format, generated through Eclipse Gendoc tool.
-
TAPI YANG Schema - The TAPI YANG models included in this TAPI release (v2.4.1) 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). YANG models included in this release are backward compatible with previous release 2.4.0.
-
TAPI OpenAPI Specification - TAPI OAS (OpenAPI Specifications) included in this TAPI release (v2.4.1) 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.
- Implementations may use other forms of REST APIs but must be based on the YANG models defined in this release and are subject to implementation agreements between concerned parties for interoperability.
-
TAPI Reference Implementation Agreement (RIA TR-547 2.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 2.0)
- 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 (TAPI RIA 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.4.1 can be obtained using
See also changelog
HighLevelDiff_Tapi2.1.3To2.4.1.pdf highlights the key changes from 2.1.3 to 2.4.1
ONF Transport API SDK 2.4.0
This is the release version 2.4.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
- OAM Service
- Path Computation Service
- Virtual Network Service
- Notification Service
- Equipment Inventory Service
- Streaming Service
- Fault Management (new)
It also includes support for the following technology-specific interface profiles
- Carrier Ethernet (L2)
- Optical Transport Network (L1-OTN)
- Photonic Media (L0-WDM)
The SDK includes the following components:
-
TAPI UML Information Model - The TAPI UML models included in this TAPI release (v2.4.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.
-
TAPI YANG Schema - The TAPI YANG models included in this TAPI release (v2.4.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 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). YANG models included in this release are not backward compatible with previous releases (including TAPI 2.1.3).
-
TAPI OpenAPI Specification - TAPI OAS (OpenAPI Specifications) included in this TAPI release (v2.4.0) are an informative part of the TAPI SDK. WARNING: The OAS is not fully aligned with the YANG at this stage. It should be used only for guidance and with extreme care. The OAS will be completed in the next release (TAPI 2.4.1).
- 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.
- Implementations may use other forms of REST APIs but must be based on the YANG models defined in this release and are subject to implementation agreements between concerned parties for interoperability.
In addition to the YANG, UML and OAS, two partly normative Reference Implementation Agreements,TR-547 and TR-548, are available at https://wiki.opennetworking.org/display/OTCC/TAPI+Reference+Implementation+Agreements+and+other+Documentation
The Reference Implementation Agreements are supported by two associated documents (https://wiki.opennetworking.org/display/OTCC/TAPI+RIA+Associated+Documents)
- TAPI Alarm and TCA list at:
- TAPI Notification and Streaming Sequences at:
As the most deployed release of TAPI at this point is TAPI 2.1.3 a detailed differences between 2.1.3 and 2.4.0 can be obtained using v2.1.3...v2.4.0-RC1.
A document that highlights the key changes from 2.1.3 to 2.4.0 is available at HighLevelDiff_Tapi2.1.3To2.4.0.pdf.
ONF Transport API SDK 2.4.0 Release Candidate 1
This is a pre-release version 2.4.0-RC1 of the ONF Transport API 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 supports technology-agnostic interfaces to the following functional modules:
- Topology Service
- Connectivity Service
- OAM Service
- Path Computation Service
- Virtual Network Service
- Notification Service
- Equipment Inventory Service
- Streaming Service
- Fault Management (new)
It also includes support for the following technology-specific interface profiles
- Carrier Ethernet (L2)
- Optical Transport Network (L1-OTN)
- Photonic Media (L0-WDM)
The SDK includes the following components:
-
TAPI UML Information Model - The TAPI UML models included in this TAPI release (v2.4.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 1.3.1
- 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.
-
TAPI YANG Schema - The TAPI YANG models included in this TAPI release (v2.4.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 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 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). YANG models included in this release are not backward compatible with previous releases (including TAPI 2.1.3).
-
TAPI OpenAPI Specification - TAPI OAS (OpenAPI Specifications) included in this TAPI release (v2.4.0) are an informative part of the TAPI SDK. WARNING: The OAS is not fully aligned with the YANG at this stage. It should be used only for guidance and with extreme care. The OAS will be completed in the next release (TAPI 2.4.1).
- 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.
- Implementations may use other forms of REST APIs but must be based on the YANG models defined in this release and are subject to implementation agreements between concerned parties for interoperability.
In addition to the YANG, UML and OAS, two partly normative Reference Implementation Agreements are also available
- TR-547: Formal version will be referenced in the v2.4.0, development version at
- TR-548: Formal version will be referenced in the v2.4.0, development version at
The Reference Implementation Agreements are supported by two associated documents (https://wiki.opennetworking.org/display/OTCC/TAPI+RIA+Associated+Documents)
- TAPI Alarm and TCA list at:
- TAPI Notification and Streaming Sequences at:
As the most deployed release of TAPI at this point is TAPI 2.1.3 a detailed differences between 2.1.3 and 2.4.0 can be obtained using v2.1.3...v2.4.0-RC1.
A document that highlights the key changes from 2.1.3 to 2.4.0 will be available with the full release.
ONF Transport API SDK 2.3.1 Pre-release
This is the pre-release version 2.3.1 of the ONF Transport API SDK
This pre-release includes some bug fixings and enhancements of release 2.3.
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 supports technology-agnostic interfaces to the following functional modules:
- Topology Service
- Connectivity Service
- OAM Service
- Fault Management Service
- Path Computation Service
- Virtual Network Service
- Notification Service
- Equipment Inventory Service
- Streaming Service
It also includes support for the following technology-specific interface profiles
- Carrier Ethernet (L2)
- Optical Transport Network (L1 - Digital OTN)
- Photonic Media (L0 - WDM)
The SDK includes the following components:
- TAPI UML Information Model - The TAPI UML models included in this TAPI release (v2.3.1) 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 1.4
- 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.
- The UML model will be also available as PDF file (TapiUmlGendoc_v2_3_1.pdf), generated from Papyrus through Gendoc tool.
- TAPI YANG Schema - The TAPI YANG models included in this TAPI release (v2.3.1) 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 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 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). YANG models included in this release are not backward compatible with previous TAPI 2.1.3 release.
- TAPI OpenAPI Specification - TAPI OAS (OpenAPI Specifications) included in this TAPI release (v2.3.1) are an informative part of the TAPI SDK and intended to support TR-547 Use Cases, where a subset of mandatory API is specified.
- 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.
- Implementations may use other forms of REST APIs but must be based on the YANG models defined in this release and are subject to implementation agreements between concerned parties for interoperability.
Changes included in this TAPI release (v2.3.1) are listed in