Skip to content

Commit 7110931

Browse files
nigel-r-davisnigel-r-davis
authored
Merge pull request #668 from nigel-r-davis/tapi-2_5_0-fixes
ReadMe file updated for TAPI 2.5.2
2 parents 5efb50e + 4e63873 commit 7110931

1 file changed

Lines changed: 34 additions & 35 deletions

File tree

‎README.md‎

Lines changed: 34 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
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.
1+
**This is the release version ***2.5.2*** of the Linux Foundation ONMI Project Transport API (TAPI) SDK
2+
This SDK is being released under the Apache 2.0 license.**
23

3-
The ONF [Transport API](https://wiki.opennetworking.org/display/OTCC/TAPI) (TAPI) project charted under the [ONF Open Transport Configuration & Control](https://opennetworking.org/open-transport/) (OTCC) is responsible for the development of this SDK as an Open Source project.
4-
5-
This release includes technology-agnostic interfaces to the following functional modules:
4+
The [LF TAPI](https://github.com/Open-Network-Models-and-Interfaces-ONMI/TAPI-Home) project is [chartered ](https://github.com/Open-Network-Models-and-Interfaces-ONMI/onmi-home/blob/main/ONMI-charter) under the LF Projects. [OMNI ](https://github.com/Open-Network-Models-and-Interfaces-ONMI/onmi-home/wiki) TAPI is responsible for the development of this SDK as an Open Source project.
65

6+
This [release](https://github.com/Open-Network-Models-and-Interfaces-ONMI/TAPI/tree/v2.5.2) includes technology-agnostic interfaces to the following functional modules:
77
- Topology Service
88
- Connectivity Service
99
- Path Computation Service
@@ -13,49 +13,48 @@ This release includes technology-agnostic interfaces to the following functional
1313
- Virtual Network Service
1414
- Notification Service
1515
- Streaming Service
16-
- gNMI Streaming Service (***NEW***)
17-
18-
It also includes support for the following technology-specific interface profiles
16+
- gNMI Streaming Service
1917

18+
It also includes support for the following technology-specific interface profiles:
2019
- Photonic Media (L0-WDM)
2120
- Optical Transport Network (L1-OTN)
22-
- Carrier Ethernet (L2)
21+
- Carrier Ethernet (L2)
2322

2423
The SDK includes the following components:
24+
- **_TAPI UML Information Model_** - The TAPI UML models included in this TAPI release (v2.5.2) are a partially normative part of the TAPI SDK and are the only source for subsequent generated TAPI SDK components (YANG, OAS, etc.).
25+
- These models are pruned/refactored from the (formerly ONF) Core Information Model (ITU-T G.7711).
26+
- 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.
27+
- Note that in earlier releases the UML was fully normative. Going forward it is expected that UML will be used solely as an aid for analysis. At this point the UML is still aligned with the YANG.
2528

26-
- **_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.).
27-
28-
- These models are pruned/refactored from the [ONF Core Information Model](https://github.com/OpenNetworkingFoundation/CoreInfoModel)
29-
- 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.
30-
- https://github.com/OpenNetworkingFoundation/TAPI/tree/develop/UmlDumpFiles: Dump of the UML models in Microsoft Word format, generated through Eclipse Gendoc tool.
31-
32-
- **_TAPI YANG Schema_** - The TAPI YANG models included in this TAPI release (v2.5.0) are a ***normative part*** of the TAPI SDK.
33-
34-
- The YANG specifications have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG mapping tool](https://github.com/OpenNetworkingFoundation/EagleUmlYang) ("Tapi_v2x" branch) and further edited manually to comply with the [ONF IISOMI UML2YANG mapping guidelines](https://wiki.opennetworking.org/display/OIMT/IISOMI+Deliverables).
35-
- 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.
36-
- 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).
29+
- **_TAPI YANG Schema_** - The TAPI YANG models included in this TAPI release (v2.5.2) are a normative part of the TAPI SDK.
30+
- The YANG specifications have been generated from the corresponding UML model using the [EAGLE UML2YANG mapping tool](https://github.com/Open-Network-Models-and-Interfaces-ONMI/onmi-iisomi-uml-yang) ("Tapi_v2x" branch) and further edited manually to comply with the [IISOMI UML2YANG mapping guidelines](https://github.com/Open-Network-Models-and-Interfaces-ONMI/onmi-iisomi-home).
31+
- 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.
32+
- The 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 [RFC7950](https://tools.ietf.org/html/rfc7950).
3733

38-
- **_TAPI OpenAPI Specification_** - TAPI OAS (OpenAPI Specifications) included in this TAPI release (v2.5.0) are an ***informative*** part of the TAPI SDK.
39-
40-
- The OAS have been generated from the YANG data models included in this release using the [ONF EAGLE YANG2OAS](https://github.com/OpenNetworkingFoundation/EagleYangOpenAPI) 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.
34+
- **_TAPI OpenAPI Specification_** - TAPI OAS (OpenAPI Specifications) included in this TAPI release (v2.5.2) are an informative part of the TAPI SDK.
35+
- The OAS have been generated from the YANG data models included in this release using the [EAGLE YANG2OAS](https://github.com/Open-Network-Models-and-Interfaces-ONMI/onmi-iisomi-yang-openapi) tool following the RESTConf protocol specification [RFC8040](https://tools.ietf.org/html/rfc8040). This specification makes no assessment as to the level of RESTConf compliance of the TAPI REST APIs.
36+
- 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.
37+
- The OAS has not been changed from the version released with TAPI release v2.5.0.
4138

42-
- [**_TAPI Reference Implementation Agreement (RIA TR-547 3.1)_**](https://github.com/OpenNetworkingFoundation/TAPI/blob/v2.5.0/TR-547-TAPI%20Reference%20Implementation%20Agreement_v3.1.pdf)
43-
44-
- 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.
39+
- [Documentation associated with this release](https://github.com/Open-Network-Models-and-Interfaces-ONMI/TAPI-Documentation/releases/tag/v2.5.2)
4540

46-
- [**_TAPI Reference Implementation Agreement for Streaming (RIA TR-548 3.1)_**](https://github.com/OpenNetworkingFoundation/TAPI/blob/v2.5.0/TR-548-TAPI_ReferenceImplementationAgreement-Streaming_v3.1.pdf)
47-
48-
- 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.
41+
As the most deployed release of TAPI at this point is TAPI 2.1.3 (TIP recommended) a detailed differences between 2.1.3 and 2.5.2 can be obtained using
42+
- https://github.com/Open-Network-Models-and-Interfaces-ONMI/TAPI/compare/v2.1.3...v2.5.2
4943

50-
The Reference Implementation Agreements are supported by two associated documents:
44+
As TAPI 2.5.x is also a TIP recommended release a detailed differences between 2.5.0 and 2.5.2 can be obtained using
45+
- https://github.com/Open-Network-Models-and-Interfaces-ONMI/TAPI/compare/v2.5.0...v2.5.2
5146

52-
- [**_TAPI Alarm TCA List v3.0.0.xlsx_**](https://github.com/OpenNetworkingFoundation/TAPI/blob/v2.5.0/TAPI_Alarm_TCA_List_v3.0.0.pdf)
53-
- [**_TAPI Notification and Streaming Sequences_**](https://github.com/OpenNetworkingFoundation/TAPI/blob/v2.5.0/TAPI_Notification_and_Streaming_Sequences.pdf)
47+
[**_HighLevelDiff_Tapi2.1.3To2.5.2.pdf_**](https://github.com/Open-Network-Models-and-Interfaces-ONMI/TAPI-Documentation/blob/v2.5.2/DeltaDocument/HighLevelDiff_Tapi2.1.3To2.5.2.pdf) highlights the key changes from 2.1.3 to 2.5.2
5448

55-
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
49+
**Summary of changes**
50+
- Correction to remove "cofig false" YANG issue
51+
- Addition of paginated get (experimental)
52+
- String field restrictions relaxed to “any conformant YANG string” throughout. Explanation added in TR-547 section 2.8 String fields.
53+
- Various minor improvements to documentation
5654

57-
- [v2.1.3...v2.5.0](https://github.com/OpenNetworkingFoundation/TAPI/compare/v2.1.3...v2.5.0)
55+
## What's Changed
56+
* Tapi 2 5 0 fixes by @nigel-r-davis in https://github.com/Open-Network-Models-and-Interfaces-ONMI/TAPI/pull/660
57+
* YANG updates for 2.5.2 by @nigel-r-davis in https://github.com/Open-Network-Models-and-Interfaces-ONMI/TAPI/pull/664
5858

59-
See also [**_changelog_**](https://github.com/OpenNetworkingFoundation/TAPI/blob/v2.5.0/changelog.txt)
6059

61-
[**_HighLevelDiff Tapi2.1.3To2.5.0.pdf_**](https://github.com/OpenNetworkingFoundation//TAPI/blob/v2.5.0/HighLevelDiff_Tapi2.1.3To2.5.0.pdf) highlights the key changes from 2.1.3 to 2.5.0
60+
**Full Changelog**: https://github.com/Open-Network-Models-and-Interfaces-ONMI/TAPI/compare/2.5.1...v2.5.2

0 commit comments

Comments
 (0)