Skip to content

ONF Transport API SDK 2.3.1 Pre-release

Pre-release
Pre-release
Compare
Choose a tag to compare
@amazzini amazzini released this 14 Oct 21:37
· 144 commits to develop since this release
v2.3.1
1f3fd94
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

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

Assets 2