Skip to content

Releases: Open-Network-Models-and-Interfaces-ONMI/TAPI

ONF Transport API SDK 2.3

19 Aug 17:07
0bba191
Compare
Choose a tag to compare

This is the release version 2.3 of the ONF Transport API SDK
This SDK is being released under the Apache 2.0 license.

Warning! This release has some bugs, it is not recommended for adoption. Amended 2.3.1 will be delivered soon.

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 (new)
  • 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) 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 is also available as PDF file (TapiUmlGendoc_v2_3.pdf), generated from Papyrus through Gendoc tool.
  • TAPI YANG Schema - The TAPI YANG models included in this TAPI release (v2.3) 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 Specififcation - TAPI OAS (OpenAPI Specifications) included in this TAPI release (v2.3) 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.

Changes included in this TAPI release (v2.3) are listed in

ONF Transport API SDK 2.3 Release Candidate 1

27 May 07:39
d93784b
Compare
Choose a tag to compare

This is a pre-release version 2.3-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
  • Fault Management Service (new)
  • 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) 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.
  • TAPI YANG Schema - The TAPI YANG models included in this TAPI release (v2.3) 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 Specififcation - TAPI OAS (OpenAPI Specifications) included in this TAPI release (v2.3) 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.

Changes included in this TAPI release (v2.3) are listed in

ONF Transport API SDK 2.1.3

19 Jun 16:50
abed972
Compare
Choose a tag to compare

This is the release version 2.1.3 of the ONF Transport API SDK
This SDK is being released under the Apache 2.0 license.

Warning: an amended version of 2.1.3 is available, with:

  • the automatically generated OAS modules, amended to include name space prefixes to the augmenting properties.

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 (new)
  • Streaming Service (new)

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

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

The SDK includes the following components:

  • TAPI UML Information Model - The TAPI UML models included in this TAPI release (v2.1.3) 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.1.3) 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 backward compatible with previous TAPI 2.1.2 release.
  • TAPI OpenAPI Specification - TAPI OAS (OpenAPI Specifications) included in this TAPI release (v2.1.3) 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.3 Release Candidate 1

27 Apr 18:01
43faa1f
Compare
Choose a tag to compare

This is a pre-release version 2.1.3-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 (new)
  • Streaming Service (new)

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

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

The SDK includes the following components:

  • TAPI UML Information Model - The TAPI UML models included in this TAPI release (v2.1.3) 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.1.3) 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 backward compatible with previous TAPI 2.1.2 release.
  • TAPI OpenAPI Specififcation - TAPI OAS (OpenAPI Specifications) included in this TAPI release (v2.1.3) 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.2

16 Jul 21:34
5d1621d
Compare
Choose a tag to compare

This is a bug-fix release version 2.1.2 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

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

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

The SDK includes the following components:

  • TAPI UML Information Model - The TAPI UML models included in this TAPI release (v2.1.2) 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.
    • It should be noted that the TapiPhotonicMedia model is experimental as some components are still under discussion at ITU-T and are a current subject of testing.
  • TAPI YANG Schema - The TAPI YANG models included in this TAPI release (v2.1.2) 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 releases.
  • TAPI OpenAPI Specififcation - TAPI OAS (OpenAPI Specifications) included in this TAPI release (v2.1.2) 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.

Changes included in this TAPI release (v2.1.2) are listed in https://github.com/OpenNetworkingFoundation/TAPI/blob/v2.1-bug-fixes/CHANGE_LOG/change-log.2.1.2.md

ONF Transport API SDK 2.2.0

26 Jul 13:46
c5fa48a
Compare
Choose a tag to compare

This is the release version 2.2.0 of the ONF Transport API SDK. This SDK is being released under the Apache 2.0 license. Changes included in this TAPI release (v2.2.0) since the previous release are listed in https://github.com/OpenNetworkingFoundation/TAPI/blob/develop/CHANGE_LOG/change-log.2.2.0.md

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 (new)

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

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

The SDK includes the following components:

  • TAPI UML Information Model - The TAPI UML models included in this TAPI release (v2.2.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.
    • It should be noted that the TapiPhotonicMedia model is experimental as some components are still under discussion at ITU-T and are a current subject of testing.
  • TAPI YANG Schema - The TAPI YANG models included in this TAPI release (v2.2.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 TAPI releases.
  • TAPI OpenAPI Specififcation - TAPI OAS (OpenAPI Specifications) 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.2.0 Release Candidate 3

05 Jul 14:59
c5fa48a
Compare
Choose a tag to compare

This is a pre-release version 2.2.0-RC3 of the ONF Transport API SDK. This SDK is being released under the Apache 2.0 license. Changes included in this TAPI release (v2.2.0) since the previous release are listed in https://github.com/OpenNetworkingFoundation/TAPI/blob/develop/CHANGE_LOG/change-log.2.2.0.md

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 (new)

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

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

The SDK includes the following components:

  • TAPI UML Information Model - The TAPI UML models included in this TAPI release (v2.2.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.
    • It should be noted that the TapiPhotonicMedia model is experimental as some components are still under discussion at ITU-T and are a current subject of testing.
  • TAPI YANG Schema - The TAPI YANG models included in this TAPI release (v2.2.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 TAPI releases.
  • TAPI OpenAPI Specififcation - TAPI OAS (OpenAPI Specifications) 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.2.0 Release Candidate 2

24 May 13:23
4a50137
Compare
Choose a tag to compare

This is a pre-release version 2.2.0-RC2 of the ONF Transport API SDK. This SDK is being released under the Apache 2.0 license. Changes included in this TAPI release (v2.2.0) since the previous release are listed in https://github.com/OpenNetworkingFoundation/TAPI/blob/develop/CHANGE_LOG/change-log.2.2.0.md

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

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

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

The SDK includes the following components:

  • TAPI UML Information Model - The TAPI UML models included in this TAPI release (v2.2.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.
    • It should be noted that the TapiPhotonicMedia model is experimental as some components are still under discussion at ITU-T and are a current subject of testing.
  • TAPI YANG Schema - The TAPI YANG models included in this TAPI release (v2.2.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 TAPI releases.
  • TAPI OpenAPI Specififcation - TAPI OAS (OpenAPI Specifications) - not included in this TAPI pre-release (v2.2.0-RC2) - are an informative part of the TAPI SDK.

ONF Transport API SDK 2.2.0 Release Candidate 1

08 Apr 22:22
Compare
Choose a tag to compare

This is a pre-release version 2.2.0-RC1 of the ONF Transport API SDK. This SDK is being released under the Apache 2.0 license. Changes included in this TAPI release (v2.2.0) since the previous release are listed in https://github.com/OpenNetworkingFoundation/TAPI/blob/develop/CHANGE_LOG/change-log.2.2.0.md

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

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

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

The SDK includes the following components:

  • TAPI UML Information Model - The TAPI UML models included in this TAPI release (v2.2.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.
    • It should be noted that the TapiPhotonicMedia model is experimental as some components are still under discussion at ITU-T and are a current subject of testing.
  • TAPI YANG Schema - The TAPI YANG models included in this TAPI release (v2.2.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 TAPI releases.
  • TAPI OpenAPI Specififcation - TAPI OAS (OpenAPI Specifications) - not included in this TAPI pre-release (v2.2.0-RC1) - are an informative part of the TAPI SDK.

ONF Transport API SDK 2.1.1

10 Dec 20:57
097b77e
Compare
Choose a tag to compare

This is a bug-fix release version 2.1.1 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

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

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

The SDK includes the following components:

  • TAPI UML Information Model - The TAPI UML models included in this TAPI release (v2.1.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.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.
    • It should be noted that the TapiPhotonicMedia model is experimental as some components are still under discussion at ITU-T and are a current subject of testing.
  • TAPI YANG Schema - The TAPI YANG models included in this TAPI release (v2.1.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 releases.
  • TAPI OpenAPI Specififcation - TAPI OAS (OpenAPI Specifications) included in this TAPI release (v2.1.1) are an informative part of the TAPI SDK and are the recommended REST API specifications to be used for TAPI interoperability based on this release.
    • 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.1.1) are listed in https://github.com/OpenNetworkingFoundation/TAPI/blob/develop/CHANGE_LOG/change-log.2.1.1.md