Download the entire repository by clicking here

This repository contains the MEF LSO Sonata SDK. It includes API definitions for the following functional areas:

• Serviceability (Address, Site Retrieval, and Product Offering Qualification Management)
• Product Quote
• Product Order
• Product Inventory

It also provides Product Specification for Access ELine as delivered by MEF W106 and EPL

The theme of this release is Servicability: it delivers full coverage of Business Requirements, API and API Developer Guides for Address, Site Retrieval, and Product Offering Qualification Management.

• All APIs have been reviewed and updated to follow their respective Business Requirements & Use Cases and Developer Guides documents
• New documents:
  • MEF W115 - LSO Sonata Quote Management API - Developer Guide
  • MEF W121 - LSO Sonata Address Management API - Developer Guide
  • MEF W122 - LSO Sonata Site Management API - Developer Guide
  • MEF W79.0.2 - Amendment to MEF 79: Address Validation, November 2020
  • MEF W92.1: LSO SOnata Test Requirements, December 2020
• Updated Documents:
  • MEF W106 - LSO Sonata Product Specification - Access E-Line
  • MEF W87 - LSO Sonata Product Offering Qualification API - Developer Guide
  • MEF 80 - Quote Management Requirements and Use Cases
  • MEF 57.2 - Product Order Management Requirements and Use Cases

The API files contained in this SDK are evolving and subject to change. They are based on documents that are either ratified standards 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:

• Address Validation, Site Query:
  • Business Requirements
    • MEF 79 - Published Standard
    • MEF 79.0.2 - Draft Release 1
  • Developer Guide/API
    • MEF W121 - LSO Sonata Address Management API - Developer Guide - work in progress - Ready for CfC#1
    • MEF W122 - LSO Sonata Site Management API - Developer Guide - work in progress - Ready for CfC#1
• Product Offering Qualification:
  • Business Requirements
    • MEF 79 - Published Standard
    • MEF 79.0.1 - Published Standard
  • Developer Guide/API - MEF W87 - work in progress - Ready for CfC#3/RfD
• Quote:
  • Business Requirements - MEF W80 - Draft Release 5
  • Developer Guide/API- MEF W115 - LSO Sonata Quote Management API - Developer Guide - work in progress, ongoing CfC#1 resolution
• Order:
  • Business Requirements - MEF 57.2 - Draft Release 1
  • Developer Guide - none
  • API - work in progress - updated to match MEF 57.2
• Inventory:
  • Business Requirements - MEF 81, MEF 81.0.1 Published Standard
  • Developer Guide - none
  • API - work in progress, updated
• Product Specifications:
  • Access E-Line - MEF W106 work in progress, after CfC#1
  • EPL - work in progress

For details on the maturity map and the roadmap for future releases please refer to LSO Sonata SDK Home Page on MEF WIKI.

This SDK contains the following items:

• COPYRIGHT - Copyright 2020 MEF Forum
• LICENSE - Contains a copy of the Apache 2.0 license
• README - This file
• api - 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
• doc - All related standards and Developer Guides.
  • cantata-sonata/carrierEthernet/epl - automatically generated documentation for EPL Product
  • sonata/carrierEthernet/accessELine - Access E-Line Product Requirements
  • serviceability/offeringQualification - MEF W87 Developer Guide
  • serviceability/address - MEF W121 Developer Guide
  • serviceability/site - MEF W122 Developer Guide
  • quote - MEF W115 Developer Guide
  • standards - The rest of documents and standards.
  • uml - A collection of UML diagrams generated from all of the API files.
• spec - Product Specification schemas for:
  • cantata-sonata/carrierEthernet/epl - EPL
  • sonata/carrierEthernet/accessELine - Access E-Line
• staticBinding - Contains static bindings of envelope APIs with Product Specification payloads. It comes in OpenAPI 3.0.

NOTE: Please note the Readme files in particular directories that provide more detailed information about corresponding functionalities.

All superseded files can be found in the Git history if needed.

Any developer intending to use the materials in this repository should first thoroughly read, review, and understand the following materials:

• MEF 55: Lifecycle Service Orchestration (LSO): Reference Architecture and Framework This document is a ratified MEF standard.
• MEF 55.0.1: Amendment to MEF 55: Operational Threads This document is a ratified MEF standard.
• MEF 55.0.2: Amendment to MEF 55: TOSCA Services Templates This document is a ratified MEF standard.
• MEF 50.1: MEF Services Lifecycle Process Flows This document is a ratified MEF standard.
• MEF 57.2: Draft Release 1 Product Order Management Requirements and Use Cases Draft Release 1
• MEF 79: Address, Service Site, and Product Offering Qualification Management This document is a ratified MEF standard.
• MEF 79.0.1: Amendment to MEF 79 Address, Service Site, and Product Offering Qualification Management Requirements and Use Cases
• MEF 79.0.2: Amendment to MEF 79: Address Validation This document is a ratified MEF standard.
• MEF 80: Quote Management Draft Release 5
• MEF 81: Product Inventory Management
• MEF 81.0.1: Amendment to MEF81 Product Inventory Management
• MEF W87: LSO Sonata Product Offering Qualification API - Developer Guide
• MEF W106: LSO Sonata Product Specification - Access E-Line
• MEF W92.1: LSO SOnata Test Requirements

Issues should be reported with the use of issues. Questions and feedback should be asked either at Sonata SDK Community 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.

The MEF LSO Sonata SDK is released under the Apache 2.0 license.

© MEF Forum 2020. All Rights Reserved.

The information in this publication is freely available for reproduction and use by any recipient and is believed to be accurate as of its publication date. Such information is subject to change without notice and MEF Forum (MEF) is not responsible for any errors. MEF does not assume responsibility to update or correct any information in this publication. No representation or warranty, expressed or implied, is made by MEF concerning the completeness, accuracy, or applicability of any information contained herein and no liability of any kind shall be assumed by MEF as a result of reliance upon such information.

The information contained herein is intended to be used without modification by the recipient or user of this document. MEF is not responsible or liable for any modifications to this document made by any other party.

The receipt or any use of this document or its contents does not in any way create, by implication or otherwise:

(a) any express or implied license or right to or under any patent, copyright, trademark or trade secret rights held or claimed by any MEF member which are or may be associated with the ideas, techniques, concepts or expressions contained herein; nor

(b) any warranty or representation that any MEF member will announce any product(s) and/or service(s) related thereto, or if such announcements are made, that such announced product(s) and/or service(s) embody any or all of the ideas, technologies, or concepts contained herein; nor

(c) any form of relationship between any MEF member and the recipient or user of this document.

Implementation or use of specific MEF standards, specifications, or recommendations will be voluntary, and no Member shall be obliged to implement them by virtue of participation in MEF Forum. MEF is a non-profit international organization to enable the development and worldwide adoption of agile, assured, and orchestrated network services. MEF does not, expressly or otherwise, endorse or promote any specific products or services.