pre Ella

Author: MichalLaczynskiAmartus

README.md

@@ -1,8 +1,8 @@
-# MEF-LSO-Sonata-SDK - Dolly Release
+# MEF-LSO-Sonata-SDK - Ella Release
 
 ## Download Link
 
-Download the entire repository by clicking [here](https://.com/MEF-GIT/MEF-LSO-Sonata-SDK/releases/download/dolly/MEF-LSO-Sonata-SDK-dolly.zip)
+Download the entire repository by clicking [here](https://.com/MEF-GIT/MEF-LSO-Sonata-SDK/releases/download/ella/MEF-LSO-Sonata-SDK-ella.zip)
 
 ## Introduction
 
@@ -22,30 +22,27 @@ This repository contains the MEF LSO Sonata SDK. It includes API definitions for
 It also provides Product Schemas for:
 
 - Access E-Line
-- EPL
-- EPLAN
-- EPTREE
-- EVPL
-- EVPLAN
-- EVPTREE
-- Basic Internet Access
-- Advanced Internet Access
+- Subscriber Carrier Ethernet (EPL, EPLAN, EPTREE, EVPL, EVPLAN, EVPTREE)
+- Internet Access
 
 ## High-level release notes
 
-- Following APIs and their respective Developer Guides have been published as MEF Standards:
-- MEF 87 - LSO Cantata and LSO Sonata Product Offering Qualification API - Developer Guide
-- MEF 115 - LSO Cantata and LSO Sonata Quote Management API - Developer Guide
-- MEF 116 - LSO Cantata and LSO Sonata Product Inventory API - Developer Guide
-- MEF 121 - LSO Cantata and LSO Sonata Address Management API - Developer Guide
-- MEF 122 - LSO Cantata and LSO Sonata Site Management API - Developer Guide
-- All APIs have been reviewed and updated to follow their respective Business Requirements & Use Cases and Developer Guides documents
-- New documents:
-- MEF W134 - Invoice Business Requirements and Use Cases
+- Documents published as MEF Standards:
+- MEF 57.2 - Product Order Management Requirements and Use Cases
+- MEF 113 - Trouble Ticketing Requirements and Use Cases
+- MEF 128 - LSO API Security Profile
+- Following documents have their Letter Ballots open and will be likely shortly published as MEF standards:
+- MEF W123 - LSO Cantata and LSO Sonata Product Order Management API - Developer Guide
+- MEF W124 - LSO Cantata and LSO Sonata Trouble Ticket and Incident Management API - Developer Guide
 - MEF W137 - LSO Cantata and LSO Sonata Appointment Management API - Developer Guide
-- MEF W139 - Internet Access Product Schemas and Developer Guide
-- New artifacts:
-- generated/security - A not normative version of the standard APIs including the security profiles as required by MEF 128. Provided for evaluation.
+- MEF W134 - Billing and Invoice Business Requirements and Use Cases
+- MEF W106 - LSO Sonata Access E-Line Product Schemas and Developer Guide
+- MEF W125 - LSO Cantata and LSO Sonata - Subscriber Ethernet Product Schemas and Developer Guide
+- New documents:
+- MEF W141 - LSO Cantata and LSO Sonata Billing Management API - Developer Guide
+- MEF W125.0.1 - Amendment to MEF 125 LSO Cantata and LSO Sonata - Subscriber Ethernet Product Schemas and Developer Guide
+
+The [LSO Marketplace](http://lso.mef.net) has introduced the possibility to blend the desired APIs with chosen Products. Thus the APIs blended with all products that were available in `generated/staticBinding` are no longer provided.
 
 **NOTE:** Please note the Readme files in particular productApi directories to see detailed release notes per API.
 
@@ -55,46 +52,55 @@ The API files contained in this SDK are evolving and subject to change. They are
 
 The maturity per functionality presents as follows:
 
+(*) is used to mark item that changes their maturity comparing to previous release.
+
 - Address Validation, Site Query:
 - Business Requirements:
 - MEF 79 - **Published Standard**
-- *MEF 79.0.2 - **Published Standard**
+- MEF 79.0.2 - **Published Standard**
 - Developer Guide/API:
-- *MEF W121 - Address Management - **Published Standard**
-- *MEF W122 - Site Management - **Published Standard**
+- MEF 121 - Address Management - **Published Standard**
+- MEF 122 - Site Management - **Published Standard**
 - Product Offering Qualification:
 - Business Requirements:
 - MEF 79 - **Published Standard**
 - MEF 79.0.1 - **Published Standard**
 - Developer Guide/API:
-- *MEF W87 - **Published Standard**
+- MEF 87 - **Published Standard**
 - Quote:
 - Business Requirements:
-- *MEF 80 - **Published Standard**
+- MEF 80 - **Published Standard**
 - Developer Guide/API:
-- *MEF W115: - **Published Standard**
+- MEF 115: - **Published Standard**
 - Order:
 - Business Requirements:
-- *MEF W57.2 - **work in progress, Draft Release 4**
+- *MEF 57.2 - **Published Standard**
 - Developer Guide/API:
-- *MEF W123 - **work in progress - ready for CfC#3**
+- *MEF W123 - **Letter Ballot**
 - Inventory:
 - Business Requirements:
 - MEF 81, MEF 81.0.1 - **Published Standard**
 - Developer Guide/API
-- *MEF W116 - **Published Standard**
+- MEF 116 - **Published Standard**
 - Trouble Ticket:
 - Business Requirements:
-- *MEF W113 - **work in progress, Draft Release 3**
+- *MEF 113 - **Published Standard**
+- Developer Guide/API
+- *MEF W124 - Trouble Ticket - **Letter Ballot**
+- *MEF W137 - Appointment - **Letter Ballot**
+- Billing:
+- Business Requirements:
+- *MEF W134 - **Letter Ballot**
 - Developer Guide/API
-- *MEF W124 - Trouble Ticket - **work in progress - ready for CfC#3**
-- *MEF W137 - Appointment - **work in progress - ready for CfC#1**
+- *MEF W141 - **work in progress - ready for CfC#1**
 - Product Specifications:
-- *MEF W106 - Access E-Line - **work in progress, CfC#2 reviewed**
-- *MEF W125 - Subscriber Ethernet (EPL, EPLAN, EPTREE, EVPL, EVPLAN, EVPTREE) - **work in progress, CfC#1 reviewed**
-- *MEF W139 - Basic and Advanced Internet Access - **work in progress - ready for CfC#1**
+- *MEF W106 - Access E-Line - **Letter Ballot**
+- *MEF W125 - Subscriber Ethernet (EPL, EPLAN, EPTREE, EVPL, EVPLAN, EVPTREE) - **Letter Ballot**
+- *MEF W125.0.1 - Amendment to Subscriber Ethernet - **work in progress - ready for CfC#1**
+- *MEF W139 - Basic and Advanced Internet Access - **work in progress - ready for CfC#2**
+- Security:
+- MEF 128 - **Published Standard**
 
-(*) is used to mark item that changes their maturity comparing to previous release.
 
 For details on the maturity map and the roadmap for future releases please refer to [LSO Sonata SDK Home Page](https://wiki.mef.net/display/CESG/LSO+Sonata+SDK) on the MEF WIKI.
 
@@ -105,39 +111,15 @@ This SDK contains the following items:
 - `COPYRIGHT` - Copyright 2022 MEF Forum
 - `LICENSE` - Contains a copy of the Apache 2.0 license
 - `README` - This file
-- `productApi` - Definitions of the API are found in this directory
-- `inventory` - Contains the API definitions necessary for inter-carrier retrieval of Product Inventory
-- `order` - Contains the API definitions for inter-carrier service ordering capability
-- `quote` - Contains the API definitions for inter-carrier service quotation capability
-- `serviceability` - Contains the APIs that allow the Service Provider or Buyer to perform:
-- `address` - Retrieve Address information including exact formats for Addresses known to the Seller
-- `offeringQualification` - Determine whether it is feasible for the Seller to deliver a particular Product with a given configuration to a particular geographic location if applicable.
-- `site` - Retrieve Service Site information including exact formats for Service Sites known to the Seller
-- `troubleTicket` - Create and manage Trouble Tickets
-- `workforce` - Manage Appointment and Work Orders
+- `productApi` - Definitions of the APIs - yaml files with schemas
 - `documentation` - All related standards and Developer Guides
-- `productApi` - API related documentation - Developer Guides
-- `inventory` - MEF 116 Developer Guide
-- `order` - MEF W123 Developer Guide
-- `quote` - MEF 115 Developer Guide
-- `serviceability/address` - MEF 121 Developer Guide
-- `serviceability/offeringQualification` - MEF 87 Developer Guide
-- `serviceability/site` - MEF 122 Developer Guide
-- `troubleTicket` - MEF W124 Developer Guide
-- `workforce` - MEF W137 Developer Guide
-- `productSchema` - product related documentation
-- `carrierEthernet` - MEF W106 and MEF W125 Product Schema Guides
-- `ip` - MEF W139 Internet Access Product Schema Guide
+- `productApi` - API related documentation - API Developer Guides
+- `productSchema` - Product related documentation - Product schema guides
 - `supportingStandards` - The rest of documents and standards.
-- `ProductSchema` - Product Specification schemas for:
-- `carrierEthernet` - Carrier Ethernet product Schemas
-- `ip` - Basic and Advanced Internet Access product schemas
+- `ProductSchema` - Product Specification schemas
 - `generated`
-- `staticBinding` - contains automatically generated (with help of the open source [Sonata Blending Tool](https://.com/Amartus/SonataBlendingTool)), not normative static bindings of envelope APIs with Product Specifications. The Address, Site and Trouble Ticket APIs are not included as they do not carry product information.
-- `full` - contains static binding of all available product schemas
-- `carrierEthernet` - contains static binding of only CarrierEthernet products
-- `ip` - contains static binding of only IP products
-- `security` - A not normative version of the standard APIs including the security profiles as required by MEF W128. Provided for evaluation.
+- `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.
 
 ## Issues, Questions, and Feedback
 
@@ -149,7 +131,7 @@ The MEF LSO Sonata SDK is released under the Apache 2.0 license.
 
 ## Copyright
 
-© MEF Forum 2022. All Rights Reserved.
+© MEF Forum 2023. All Rights Reserved.
 
 ## Disclaimer