Skip to content

MEF LSO Sonata SDK Release Candidate 5
Compare
Choose a tag to compare
@MichalLaczynskiAmartus MichalLaczynskiAmartus released this 31 Jul 23:35
· 60 commits to working-draft since this release
rc5
1a98df7
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.

MEF-LSO-Sonata-SDK (Release Candidate 5)

Download Link

Download the entire repository by clicking here

Overview

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

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

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

High-level release notes

  • MEF W87 - LSO Sonata Product Offering Qualification API - Developer Guide. The first of a series of developer guides that explain the details of MEF API usage, process flows, and the pattern resulting from the combining of the TMF-based envelope with Product Specifications. It comes with the update of POQ API Specification.

  • MEF W106 - LSO Sonata Product Specification - Access E-Line which includes JSON schemas and the Requirements document.

  • Update of all of LSO Sonata APIs:

    • Use of TM Forum tooling based on Domain Context Specialization rules to ensure alignment with TM Forum APIs (see MEF-TMF-ONAP-Collaboration)
    • Introduction of envelope-payload and product characteristic patterns as described in MEF W87
    • Bug fixes and improvements

  • Static binding of envelope APIs with Product Specification payloads.

Maturity Level

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.1 - undergoing Letter Ballot
    • Developer Guide - none
    • API - work in progress

  • Product Offering Qualification:

    • Business Requirements - MEF 79 - Published Standard
    • Developer Guide - MEF W87 - work in progress - closed resolution of CfC#1
    • API - MEF W87 - work in progress - closed resolution of CfC#1

  • Quote:

    • Business Requirements - MEF W80 - Draft (R7)
    • Developer Guide - open project, not yet included
    • API - work in progress, aligned with MEF W80 Draft (R7)

  • Order:

    • Business Requirements - MEF 57.1 - Published Standard (the next version MEF W57.2 is being prepared)
    • Developer Guide - none
    • API - work in progress

  • Inventory:

    • Business Requirements - MEF 81, MEF 81.0.1 Published Standard
    • Developer Guide - none
    • API - work in progress

  • Access E-Line Product Specification

    • Requirements - MEF W106 - work in progress - start of CfC#1
    • JSON Schemas - MEF W106 - work in progress - start of CfC#1

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

Contents

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.
    • product/carrierEthernet/accessELine - Contains the Requirement document for Access E-Line (MEF W106)
    • serviceability/offeringQualification - MEF W87 Developer Guide
    • standards - The rest of documents and standards.
    • uml - A collection of UML diagrams generated from all of the API files.
  • spec - hold product specifications
    • product/carrierEthernet/accessEline/ - Contains reference JSON schemas for Access E-Line delivered by MEF W106
  • 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.

Precedents

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

Issues, questions, and Feedback

Issues should be reported with the use of GitHub issues.
Questions and feedback should be asked either at Sonata SDK Community or directly to community_manager@mef.net.

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.

Copyright

© MEF Forum 2020. All Rights Reserved.

Disclaimer

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.

Assets 3
Loading