pre - release

Author: MichalLaczynskiAmartus

README.md

@@ -1,34 +1,85 @@
-# MEF-LSO-Interlude-SDK Fergie Release
+# MEF-LSO-Interlude-SDK Grace Release
 
 ## Download Link
 
-Download the entire repository by clicking [here](https://.com/MEF-GIT/MEF-LSO-Interlude-SDK/releases/download/fergie/MEF-LSO-Interlude-SDK-fergie.zip)
+Download the entire repository by clicking [here](https://.com/MEF-GIT/MEF-LSO-Interlude-SDK/releases/download/grace/MEF-LSO-Interlude-SDK-grace.zip)
 
 ## Overview
 
-This repository contains the release of the Interlude SDK. The SDK includes APIs for Performance Monitoring and metrics definitions.
+This repository contains the release of the Interlude SDK. The SDK includes APIs for Service Catalog, Service Order, and Service Inventory functions of the Service Orchestration Functionality (SOF) at the LSO Interlude Interface Reference Point (IRP) as defined in the MEF LSO Reference Architecture.
 
-**This is the first release of this SDK.**
+Also included are Service schemas and Performance Monitoring definitions .
 
-## Scope and Maturity
+## High-level release notes
 
-(*) is used to mark item that changes their maturity comparing to previous release.
+- Internet Protocol schemas are revised and updated, together with their guide documents (MEF W102)
+- New document:
+- MEF 55.1.1 Amendment to MEF 55.1: Reference Architecture and Framework - Terminology
+- Updated documents:
+- MEF W128.1 - LSO API Security Profile
+- MEF W133.1 - Allegro, Interlude and Legato Fault Management and Performance Monitoring BR&UC
+- MEF W143 - Performance Monitoring API and Developer Guide
+- MEF W147 - Management API and Developer Guide
 
-SOAM:
+## Scope
+
+It includes API definitions for the following functional areas:
 
-- *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 - Management API and Developer Guide - **work in progress - CfC#1**
-- Performance Monitoring reports and statistics definitions for Carrier Ethernet adn IP - **early draft version**
+- Service Catalog - This includes support for
+- Service Specification - Retrieve operations only
+- Not in scope
+- Service Specifications - Create, Amend/Modify, Delete operations
+- Service Catalog, Service Category, Service Candidate, Job/Task
+- Service Ordering - This includes support for
+- Service Order/OrderItem - Create, Retrieve operations only
+- Not in scope
+- Service Order/OrderItem - Amend/Modify/Cancel, Delete operations
+- Service Inventory - This includes support for
+- Service - Retrieve operations only
+- Not in scope
+- Service - Create, Amend/Modify, Delete operations
+
+In addition to the Service Provisioning APIs, the SDK includes the following MEF Service Specification schemas:
+
+- SD-WAN Services
+- Carrier Ethernet Services
+- L1 Connectivity Services
+- IP/IP-VPN Services
 
 The MEF LSO Interlude SDK is released under the Apache 2.0 license.
 
 More information about the LSO Interlude API reference point and it's roadmap can be found here:
 
 https://wiki.mef.net/display/CESG/LSO+Interlude
 
+## Maturity Level
+
+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.
+
+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**
+
+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#4**
+- 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, CfC#1**
+- MEF 136 - Service Function Testing Business Requirements and Use Cases - **Published Standard**
+- *MEF W143 - Performance Monitoring API and Developer Guide - **work in progress - CfC#2**
+- *MEF W147 - Management API and Developer Guide - **work in progress - CfC#2**
+- Performance Monitoring reports and statistics definitions for Carrier Ethernet adn IP - **early draft version, schemas only**
+
 ## Contents
 
 This SDK contains the following items:
@@ -40,13 +91,19 @@ This SDK contains the following items:
 - `serviceSchema` - Contains JSON schema (draft 7) files for service specifications.
 - `documentation` - documentation including API/Schema developer guides and openapi-tools generated API descriptions in markdown format
 - `supportingStandards` - The rest of documents and standards.
-- `generated`
-- `staticBinding` - No longer provided - please visit [LSO Marketplace](http://lso.mef.net) to use self-blending possibility.
-- `security` - A not normative version of the standard APIs including the security profiles as required by MEF 128. Provided for evaluation.
+- `generated` - No longer provided - please visit [LSO Marketplace](http://lso.mef.net) to use self-blending possibility.
 
 ## Issues, questions, and Feedback
 
-Issues should be reported with the use of issues or directly to [email protected].
+Issues should be reported with the use of issues. Questions and feedback should be asked either at [Interlude SDK Discussions](https://.com/MEF-GIT/MEF-LSO-Interlude-SDK/discussions) or directly to [email protected].
+
+**NOTE:** All artifacts included in this repository have line numbers. When referring to specific content in any of these artifacts, please quote the line numbers to which you are referring.
+
+## Reference Implementations
+
+A reference implementation of the MEF Service Instantiation API may be available from the ONAP EXTAPI project.
+
+https://wiki.onap.org/display/DW/External+API+Framework+Project
 
 ## Copyright