pre release

MEF-GIT · Jun 23, 2023 · 7f72397 · 7f72397
1 parent 0e83943
commit 7f72397
Show file tree

Hide file tree

Showing 302 changed files with 40,982 additions and 2,647 deletions.
diff --git a/.gitignore b/.gitignore
diff --git a/.prettierrc.yml b/.prettierrc.yml
@@ -0,0 +1,6 @@
+trailingComma: 'es5'
+tabWidth: 2
+semi: false
+singleQuote: true
+printWidth: 79
+proseWrap: always
diff --git a/.project b/.project
diff --git a/README.md b/README.md
@@ -1,24 +1,24 @@
-# MEF-LSO-Legato-SDK Ella Release
+# MEF-LSO-Legato-SDK Fergie Release
 
 ## Download Link
 
-Download the entire repository by clicking [here](https://github.com/MEF-GIT/MEF-LSO-Legato-SDK/releases/download/ella/MEF-LSO-Legato-SDK-ella.zip)
+Download the entire repository by clicking [here](https://github.com/MEF-GIT/MEF-LSO-Legato-SDK/releases/download/fergie/MEF-LSO-Legato-SDK-fergie.zip)
 
 ## Overview
 
-This repository contains the release of the Legato SDK. The SDK includes APIs for Service Catalog, Service Order, Service Inventory and Service Notification functions of the Service Orchestration Functionality (SOF) at the LSO Legato Interface Reference Point (IRP) as defined in the MEF LSO Reference Architecture.
+This repository contains the release of the Legato SDK. The SDK includes APIs for Service Catalog, Service Order, and Service Inventory functions of the Service Orchestration Functionality (SOF) at the LSO Legato Interface Reference Point (IRP) as defined in the MEF LSO Reference Architecture.
 
-Also included are draft, in-progress versions of the API Developer Guides for each of the service types listed above.
+Also included are Service schemas and Performance Monitoring definitions .
 
 ## High-level release notes
 
-- Service Ordering and Service Inventory APIs are updated to match all Sonata API patterns and have API Developer Guide documents provided (MEF W99 and MEF W135).
-- Carrier Ethernet and IP service schemas are revised and updated, together with their guide documents (MEF W101, MEF W102)
+- SD-WAN service schemas are revised and updated, together with their guide documents (MEF W100)
 - Following documents have been published as MEF Standards:
-  - MEF 112 - Draft Release 1 MEF Services Model Information Model for IP and IP VPN
-  - MEF 128 - Draft Release 2 LSO API Security Profile
+  - MEF 133 - Allegro, Interlude and Legato Fault Management and Performance Monitoring BR&UC
+  - MEF 136 - Service Function Testing Business Requirements and Use Cases
 - New document:
-  - MEF W133 - Allegro, Interlude and Legato Fault Management and Performance Monitoring BR&UC
+  - MEF W128.1 - LSO API Security Profile
+  - MEF W133.1 - Allegro, Interlude and Legato Fault Management and Performance Monitoring BR&UC
 
 ## Scope
 
@@ -37,15 +37,6 @@ It includes API definitions for the following functional areas:
   - Service - Retrieve operations only
   - Not in scope
     - Service - Create, Amend/Modify, Delete operations
-- Service Notification - This includes support for
-  - Hub - Create, Delete, Retrieve operations
-  - Service Specification - Create, Delete, StateChange event notifications
-  - Service Order/OrderItem - Create, StateChange event notifications
-  - Service events - Create, Delete, StateChange event notifications
-  - Not in scope
-    - Hub - Modify operations
-    - Retrieve Notification records history/log
-    - AttributeValueChange event notifications
 
 In addition to the Service Provisioning APIs, the SDK includes the following MEF Service Specification schemas:
 
@@ -64,22 +55,37 @@ https://wiki.mef.net/display/CESG/LSO+Legato
 
 The API files contained in this SDK are evolving and subject to change. They are based on documents that are either work in progress or draft standards that have not yet completed the review cycles and approvals necessary to achieve the status as a MEF standard. MEF is making these publicly available at this time to invite wider industry review.
 
-There is currently [LSO Legato Service Provisioning Project](https://wiki.mef.net/display/LSO/LSO+Legato+Service+API+-+Project+Home+Page) open that aims to deliver:
-
-- *LSO Legato Service Ordering Management API (MEF W99) - **work in progress - ready for CfC#2**
-- *LSO Legato Service Inventory Management API - Developer Guide (MEF W135) - **work in progress - ready for CfC#2**
-- LSO Legato Service Provisioning Specification - SD-WAN (MEF W100) - **DRAFT version**
-- *LSO Legato Carrier Ethernet Service Schemas and Developer Guide (MEF W101) - **work in progress - ready for CfC#2**
-- *LSO Legato Internet Protocol Service Schemas and Developer Guide (MEF W102) - **work in progress - ready for CfC#2**
-- LSO Legato Service Provisioning Specification - L1 (MEF W103) - **DRAFT version**
+The maturity per functionality presents as follows:
 
 (*) is used to mark item that changes their maturity comparing to previous release.
 
+APIs and Developer Guides:
+
+- Service Catalog API - **early draft version, on hold**
+- MEF W99 - LSO Service Ordering Management API - Developer Guide W99 - **work in progress - requested LB**
+- MEF W135 - LSO Legato Service Inventory Management API - Developer Guide - **work in progress - requested LB**
+
+Service Schemas:
+
+- *SD-WAN (MEF W100) - **work in progress - CfC#2**
+- Carrier Ethernet (MEF W101) - **work in progress - CfC#2**
+- Internet Protocol (MEF W102) - **work in progress - CfC#2**
+- LSO Legato Service Provisioning Specification - L1 (MEF W103) - **work in progress - CfC#3 - on hold**
+
+SOAM:
+
+- *MEF 133 - Allegro, Interlude and Legato Fault Management and Performance Monitoring BR&UC - **Published Standard**
+- *MEF W133.1 - Allegro, Interlude and Legato Fault Management and Performance Monitoring BR&UC - **early draft version**
+- *MEF 136 - Service Function Testing Business Requirements and Use Cases - **Published Standard**
+- *MEF W143 - Performance Monitoring Profiles, Jobs, Notifications and Collection API and Developer Guide	- **work in progress - CfC#1**
+- *MEF W147 - Streaming Management API and Developer Guide - **work in progress - CfC#1**
+- Performance Monitoring reports and statistics definitions for Carrier Ethernet adn IP - **early draft version**
+
 ## Contents
 
 This SDK contains the following items:
 
-- `COPYRIGHT` - Copyright 2020 MEF Forum
+- `COPYRIGHT` - Copyright 2023 MEF Forum
 - `LICENSE` - Contains a copy of the Apache 2.0 license
 - `README` - This file
 - `serviceApi` - Definitions of the APIs are found in this directory, provided as yaml files.

diff --git a/...ory/MEF W135 - LSO Legato Service Inventory Management API - Developer Guide.md b/...ory/MEF W135 - LSO Legato Service Inventory Management API - Developer Guide.md
@@ -13,14 +13,14 @@ img
 <div style="font-weight:bold; font-size:33pt; font-family: sensation;  text-align:center">
 Working Draft
 </br>
-MEF W135 v0.1
+MEF W135 v0.2
 </br>
 </br>
 LSO Legato Service Inventory Management API - Developer Guide
 </br>
 <p style="color:red;font-weight:bold; font-size:18pt">This draft represents MEF work in progress and is subject to change.</p>
 </br>
-January 2023
+June 2023
 </br>
 <p style="color:red;font-weight:bold; font-size:18pt">EXPORT CONTROL: This document contains technical data. The download, export, re-export or disclosure of the technical data contained in this document may be restricted by applicable U.S. or foreign export laws, regulations and rules and/or applicable U.S. or foreign sanctions ("Export Control Laws or Sanctions"). You agree that you are solely responsible for determining whether any Export Control Laws or Sanctions may apply to your download, export, reexport or disclosure of this document, and for obtaining (if available) any required U.S. or foreign export or reexport licenses and/or other required authorizations.</p>
 </div>
@@ -156,6 +156,7 @@ contained herein.
     - [7.3.3. Type ServiceEventPayload](#733-type-serviceeventpayload)
     - [7.3.4. `enum` ServiceEventType](#734-enum-serviceeventtype)
 - [8. References](#8-references)
+- [Appendix A Acknowledgments](#appendix-a-acknowledgments)
 
 <div class="page"/>
 
@@ -164,13 +165,17 @@ contained herein.
 The following members of the MEF participated in the development of this
 document and have requested to be included in this list.
 
-| Member |
-| ------ |
-|        |
-|        |
+| Member   |
+| -------- |
+| Amartus  |
+| Cisco    |
+| Lumen    |
+| Verizon  |
 
 **Table 1. Contributing Members**
 
+<div class="page"/>
+
 # 1. Abstract
 
 This standard is intended to assist the implementation of the Application
@@ -180,14 +185,18 @@ Legato Interface Reference Point is defined in the MEF 55.1
 [[MEF55.1](#8-references)] at the interface between the Business Application
 Systems layer and Service Orchestration Functionality layer.
 
-This Standard normatively incorporates the following OpenAPI 3.0 definitions by
-reference as if they were part of this document, from the MEF-GIT GitHub
-repository _working_draft_ branch:
+This standard normatively incorporates the following files by reference as if
+they were part of this document from the GitHub repository:
+
+[MEF-LSO-Legato-SDK](<https://github.com/MEF-GIT/MEF-LSO-Legato-SDK>)
 
-<https://github.com/MEF-GIT/MEF-LSO-Legato-SDK>
+commit id:
+[0e83943f529e87c036a083926a1b28a0a3523c5e](https://github.com/MEF-GIT/MEF-LSO-Legato-SDK/tree/0e83943f529e87c036a083926a1b28a0a3523c5e)
 
-- `serviceApi\inventory\serviceInventoryManagement.api.yaml`
-- `serviceApi\inventory\serviceInventoryNotification.api.yaml`
+- [`serviceApi/inventory/serviceInventoryManagement.api.yaml`](https://github.com/MEF-GIT/MEF-LSO-Legato-SDK/blob/0e83943f529e87c036a083926a1b28a0a3523c5e/serviceApi/inventory/serviceInventoryManagement.api.yaml)
+- [`serviceApi/inventory/serviceInventoryNotification.api.yaml`](https://github.com/MEF-GIT/MEF-LSO-Legato-SDK/blob/0e83943f529e87c036a083926a1b28a0a3523c5e/serviceApi/inventory/serviceInventoryNotification.api.yaml)
+
+<div class="page"/>
 
 # 2. Terminology and Abbreviations
 
@@ -225,6 +234,8 @@ document by reference, and are not repeated in the table below.
 
 **Table 3. Abbreviations**
 
+<div class="page"/>
+
 # 3. Compliance Levels
 
 The key words **"MUST"**, **"MUST NOT"**, **"REQUIRED"**, **"SHALL"**, **"SHALL
@@ -240,6 +251,8 @@ words **SHOULD** or **SHOULD NOT**) are labeled as **[Dx]** for desirable. Items
 that are **OPTIONAL** (contain the words MAY or OPTIONAL) are labeled as
 **[Ox]** for optional.
 
+<div class="page"/>
+
 # 4. Introduction
 
 This standard specification document describes the Application Programming
@@ -591,8 +604,8 @@ The Legato SDK contains service specification definitions, from which IPVC and
 IPVC End Point are used in the payload samples in this section. The schemas are
 located in the SDK package at:
 
-- `serviceSchema\ip\ipvc.yaml`
-- `serviceSchema\ip\ipvcEndPoint.yaml`
+- `serviceSchema/ip/ipvc.yaml`
+- `serviceSchema/ip/ipvcEndPoint.yaml`
 
 The service specification data model definitions are available as JsonSchema
 (version `draft 7`) documents. Figures 6 and 7 depict simplified UML views on
@@ -603,7 +616,7 @@ these data models in which:
 - some relations and attributes that are not essential to the understanding of
   the service specification model are omitted.
 
-The red color in figures 6 and 7 below highlights the data model of services.
+The red color in Figures 6 and 7 below highlights the data model of services.
 Some parts of the model are skipped for examples clarity. This is denoted by the
 `<<skipped>>` text in diagrams and in json snippets later in the document.
 Please note that this document uses service specifications just for the sake of
@@ -705,7 +718,7 @@ The flow is a simple request-response pattern, as presented in Figure 9:
 
 **Figure 9. Use case 1: Retrieve Service by Service Identifier flow**
 
-The model taking part in this use case is presented in Figure 10
+The model taking part in this use case is presented in Figure 10:
 
 ![Use case 1](media/useCase1Model.png)
 
@@ -779,7 +792,7 @@ Additions and changes to Services in the Service Inventory can be performed with
 use of Service Orders and the Service Order Management API, or by the request of
 the SOF.
 
-A detailed description of each state can be found in the table below.
+A detailed description of each state can be found in the Table 7 below.
 
 | State              | Description                                                                                                           |
 | ------------------ | --------------------------------------------------------------------------------------------------------------------- |
@@ -1131,7 +1144,7 @@ the API: `POST /hub`. The request contains only 2 attributes:
   notified to,
 - `query` - optional, to provide the required types of event.
 
-The figure below shows all entities involved in the Notification use cases.
+Figure 14 shows all entities involved in the Notification use cases.
 
 ![Figure 14](media/ServiceNotificationModel.png)
 
@@ -2675,6 +2688,8 @@ Inherits from:
     </tbody>
 </table>
 
+<div class="page"/>
+
 # 8. References
 
 - [JSON Schema draft 7](https://json-schema.org/specification-links.html#draft-7),
@@ -2729,3 +2744,20 @@ Inherits from:
   TMF630 API Design Guidelines 4.2.0
 - [TMF638](https://www.tmforum.org/resources/specification/tmf638-service-inventory-api-user-guide-v4-0-0/)
   TMF638 Service Inventory API User Guide, May 2020
+
+<div class="page"/>
+
+# Appendix A Acknowledgments
+
+The following contributors participated in the development of this document and
+have requested to be included in this list.
+
+Mike **BENCHECK**
+
+Michał **ŁĄCZYŃSKI**
+
+Jack **PUGACZEWSKI**
+
+Karthik  **SETHURAMAN**
+
+Mehmet **TOY**
diff --git a/...pi/inventory/MEF W135 - LSO Legato Service Inventory Management API - Developer Guide.pdf b/...pi/inventory/MEF W135 - LSO Legato Service Inventory Management API - Developer Guide.pdf