The LSO Cantata SDK is the complete set of deliverables developed by the MEF membership in order to
- Enable market adoption of LSO Cantata APIs in the current release of the LSO API Framework.
- Support of development of additional features for the upcoming release of the LSO Cantata SDK.
The latest release of LSO Cantata SDK is in the LSO API Release 'Billie' and is available on GitHub (see Latest Release section for details).
Any MEF member can participate in the development of each new release of the LSO Cantata SDK:
Contact the LSO Developer Community Manager (Michał Łączyński ) either via GitHub or by email to let him know of your interest and to ask questions
MEF-LSO-Cantata-SDK - Billie Release (Production)
Download Link
Download the entire repository by clicking
here
Introduction
This repository contains the MEF LSO Cantata SDK. It includes API definitions
for the following functional areas:
- Serviceability
- Address
- Site Retrieval
- Product Offering Qualification Management
- Product Quote
- Product Order
- Product Inventory
- Trouble Ticket
It also provides Product Schemas for:
- EPL
- EPLAN
- EPTREE
- EVPL
- EVPLAN
- EVPTREE
High-level release notes
With this release Cantata is reusing all of Sonata APIs. The theme of this
release is Ordering and Inventory: it delivers full coverage of Business
Requirements, API and API Developer Guides for all above mentioned Cantata API
functions.
- All APIs have been reviewed and updated to follow their respective Business
Requirements & Use Cases and Developer Guides documents - All API definitions are provided in OAS 3.0 standard.
- New documents:
- MEF W87 - LSO Cantata and LSO Sonata Product Offering Qualification API
Developer Guide - MEF W115 - LSO Cantata and LSO Sonata Quote Management API Developer Guide
- MEF W121 - LSO Cantata and LSO Sonata Address Management API Developer Guide
- MEF W122 - LSO Cantata and LSO Sonata Site Management API Developer Guide
- MEF W116 - LSO Cantata and LSO Sonata Product Inventory API - Developer
Guide - MEF W123 - LSO Cantata and LSO Sonata Product Order Management API -
Developer Guide - MEF W124 - LSO Cantata and LSO Sonata Trouble Ticketing API - Developer Guide
- MEF W125 - LSO Cantata and LSO Sonata Product Specification - Subscriber
Ethernet - Schema Guide
- MEF W87 - LSO Cantata and LSO Sonata Product Offering Qualification API
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.2 - Draft Release 2, Letter Ballot pending
- Developer Guide/API
- MEF W121 - LSO Cantata and LSO Sonata Address Management API - Developer Guide - work in progress - CfC#1 reviewed
- MEF W122 - LSO Cantata and LSO Sonata Site Management API - Developer Guide - work in progress - CfC#1 reviewed
- Business Requirements
- Product Offering Qualification:
- Business Requirements
- MEF 79 - Published Standard
- MEF 79.0.1 - Published Standard
- Developer Guide/API - MEF W87 - work in progress - Draft Standard (R1), Ready for CfC#4
- Business Requirements
- Quote:
- Business Requirements - MEF W80 - Draft Release 6, Letter Ballot pending
- Developer Guide/API- MEF W115 - LSO Cantata and LSO Sonata Quote Management API - Developer
Guide - work in progress, CfC#1 reviewed
- Order:
- Business Requirements - MEF 57.2 - Draft Release 2
- Developer Guide/API - work in progress - ready fo CfC#1
- Inventory:
- Business Requirements - MEF 81, MEF 81.0.1 Published Standard
- Developer Guide/API - work in progress - ready for CfC#1
- Trouble Ticket:
- Business Requirements - MEF W113 - Draft Release 1
- Developer Guide/API - work in progress - ready for CfC#1
- Business Requirements - MEF W113 - Draft Release 1
- Product Specifications:
- Access E-Line - MEF W106 work in progress, CfC#2 reviewed
- EPL, EPLAN, EPTREE, EVPL, EVPLAN, EVPTREE - work in progress
For details on the maturity map and the roadmap for future releases please refer
to
LSO Cantata SDK Home Page
on the MEF WIKI.
Contents
This SDK contains the following items:
COPYRIGHT
- Copyright 2020 MEF ForumLICENSE
- Contains a copy of the Apache 2.0 licenseREADME
- This fileproductApi
- Definitions of the API are found in this directoryinventory
- Contains the API definitions necessary for inter-carrier
retrieval of Product Inventoryorder
- Contains the API definitions for inter-carrier service ordering
capability.quote
- Contains the API definitions for inter-carrier service quotation
capabilityserviceability
- Contains the APIs that allow the Service Provider or
Buyer to perform:address
- Retrieve Address information including exact formats for
Addresses known to the SellerofferingQualification
- 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
documentation
- All related standards and Developer Guides.productApi
- API related documentation - Developer Guidesinventory
- MEF W116 Developer Guideorder
- MEF W123 Developer Guidequote
- MEF W115 Developer Guideserviceability/address
- MEF W121 Developer Guideserviceability/offeringQualification
- MEF W87 Developer Guideserviceability/site
- MEF W122 Developer GuidetroubleTicket
- MEF W124 Developer Guide
productSchema
- product related documentationcarrierEthernet
- MEF W106 and MEF W125 Product Schema Guides
supportingStandards
- The rest of documents and standards.
ProductSchema
- Product Specification schemas for:carrierEthernet
- Carrier Ethernet product Schemas
generated/staticBinding/full
- contains automatically generated (with help
of the open source
Sonata Blending Tool), not
normative static bindings of envelope APIs with Product Specification
payloads.
Issues, Questions, and Feedback
Issues should be reported with the use of GitHub issues. Questions and feedback
should be asked either at
Cantata 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 Cantata SDK is released under the Apache 2.0 license.
BR&UC - Business Requirements & Use Cases
Underlined item indicates a release deliverable that is a delta from the previous SDK release.
Published standard | Draft standard | Work in progress |
---|
LSO Cantata SDK Billie (Production)
Version: billie
Date: 3rd June 2021
Function | BR&UC | LSO Sonata API | Product specification | Blended envelope + payload (OAS 3.0) | Tooling | ||
---|---|---|---|---|---|---|---|
Developer Guide | MEF branded TMF envelope API | Requirements | JSON Schema | ||||
Address Validation | MEF 79 MEF 79.0.2 (Draft Standard R2) | MEF 121 (CfC#1 resolved) | geographicAddressManagement (1.0.0-RC) | N/A | N/A | ||
Site Query | MEF 79 | MEF 122 (CfC#1 resolved) | geographicSiteManagement (1.0.0-RC) | N/A | N/A | ||
Product Offering Qualification (POQ) | MEF 79 MEF 79.0.1 | MEF 87 (CfC#3 resolved) | productOfferingQualificationManagement (1.0.0-RC) productOfferingQualificationNotification (1.0.0-RC) | MEF W125 (working draft) | Subscriber Ethernet | SonataBlendingTool | |
Quoting | MEF 80 (Draft Standard R6) | MEF W115 (CfC#1 resolved) | quoteManagement (1.0.0-RC) quoteNotification (1.0.0-RC) | MEF W125 (working draft) | Subscriber Ethernet | ||
Product Inventory | MEF 81 MEF 81.0.1 | MEF W116 (CfC#1 working draft) | productInventoryManagement (1.0.0-RC) | MEF W125 (working draft) | Subscriber Ethernet | ||
Product Order | MEF W57.2 (Draft Standard R2) | MEF W123 (CfC#1 working draft) | productOrderManagement (2.0.0-RC) productOrderNotification (2.0.0-RC) | MEF W125 (working draft) | Subscriber Ethernet | ||
Trouble Ticketing | MEF W113 (Draft Standard R1) | MEF W124 (working-draft, CfC#1 ready) | troubleTicketManagement (1.0.0-RC) troubleTicketNotification (1.0.0-RC) | N/A | N/A | ||
Billing | |||||||
Test Requirements | MEF W92.1 (Draft Standard R1) |
Release Billie Deliverables
Bolded Deliverables are part of the release's theme: "Ordering and Inventory"
Deliverable | Maturity | Comment |
---|---|---|
MEF W57.2 Order BR&UC | Draft Standard (R2) | |
MEF W116 Inventory DevGuide+API | Working Draft (CfC#1 ready) | |
MEF 123 Order DevGuide+API | Working Draft (CfC#1 ready) | |
MEF W125 - Subscriber Ethernet Schemas and Product Schema Guide | Working Draft | EPL, EVPL, EP-LAN, EVP-LAN, EP-TREE, EVP-TREE Subscriber UNI |
MEF 79.0.2 79 Address amendment | Draft Standard (R2), (LB pending) | |
MEF 80 Quote BR&UC | Draft Standard (R6), (LB pending) | |
MEF 115 Quote DevGuide+API | CfC#1 resolved, (CfC#2 ready) | lots of changes in MEF 80 |
MEF 87 POQ DevGuide + API | CfC#3 resolved, (CfC#4 ready) | |
MEF 121 Address Dev Guide + API | Working Draft (CfC#1 ready) | |
MEF 122 Site Dev Guide + API | Working Draft (CfC#1 ready) | |
MEF W113 Trouble Ticketing | Draft Standard (R1) | |
MEF W124 Sonata API & Developer Guide - Trouble Ticketing | Working Draft (CfC#1 ready) | |
MEF W92.1: LSO Sonata Test Requirements | Draft Standard (R1) |
LSO Cantata SDK Celine (November 2021)
Git tag:
Function | BR&UC | LSO Cantata API | Product specification | Blended envelope + payload (OAS 3.0) | Tooling | ||
---|---|---|---|---|---|---|---|
Developer Guide | MEF branded TMF envelope API | Requirements | JSON Schema | ||||
Address Validation | MEF 79 MEF 79.0.2 (Draft R2) | MEF 121 | GeographicAddressManagement | N/A | N/A | ||
Site Query | MEF 79 | MEF 122 | GeographicSiteManagement | N/A | N/A | ||
Product Offering Qualification (POQ) | MEF 79 MEF 79.0.1 | MEF 87 | ProductOfferingQualificationManagement ProductOfferingQualificationNotification | MEF 125 | Subscriber Ethernet | SonataBlendingTool | |
Quoting | MEF 80 | MEF 115 | QuoteManagement QuoteNotification | MEF 125 | Subscriber Ethernet | ||
Product Inventory | MEF 81 MEF 81.0.1 | MEF 116 | ProductInventoryManagement | MEF 125 | Subscriber Ethernet | ||
Product Order | MEF 57.2 | MEF W123 Draft Standard (R1) | ProductOrderManagement ProductOrderNotification | MEF 125 | Subscriber Ethernet | ||
Trouble Ticketing | MEF 113 | MEF W124 Draft Standard (R1) | N/A | N/A | |||
Billing | |||||||
Test Requirements | MEF W92.1 Draft Standard (R2) |
Release Celine Deliverables
Deliverable | Maturity |
---|---|
MEF 57.2 Order BR&UC | Standard |
MEF 116 Inventory DevGuide+API | Standard |
MEF 123 Order DevGuide+API | CfC#1 resolved |
MEF 125 - Subscriber Ethernet Schemas and Product Schema Guide | Standard |
MEF 121 Address Dev Guide + API | CfC#2 resolved |
MEF 122 Site Dev Guide + API | CfC#2 resolved |
MEF 113 Trouble Ticketing | Standard |
MEF 124 Sonata API & Developer Guide - Trouble Ticketing | CfC#1 resolved |
MEF W92.1: LSO Sonata Test Requirements | Draft Standard (R2) |
LSO Cantata SDK Aretha
Version: aretha
Date: 22nd December 2020
Function | BR&UC | LSO Cantata API | Product specification | Blended envelope + payload (OAS 3.0) | ||
---|---|---|---|---|---|---|
Developer Guide | MEF branded TMF envelope API | Requirements | JSON Schema | |||
Address Validation | N/A | N/A | ||||
Site Query | N/A | N/A | ||||
Product Offering Qualification (POQ) | ||||||
Quoting | ||||||
Product Inventory | ||||||
Product Order | MEF W57.2 (Draft Standard R2) | ProductOrderManagement - 1.0.0-RC ProductOrderNotification - 1.0.0-RC | EPL | |||
Trouble Ticketing | N/A | N/A | ||||
Billing | N/A | N/A |
Release Aretha Deliverables
Bolded Deliverables are part of the release's theme "Pre-order"
Deliverable | Maturity |
---|---|
Order API | Working Draft updated to 57.2 Draft Standard (R2) (basic scope) |
MEF W57.2 Order BR&UC | Draft Standard R2 (basic scope) |
EPL Product Schema | Working draft |
PUBLIC
Core (public):
https://github.com/MEF-GIT/MEF-LSO-Cantata-SDK
Extensions (MEF Members only):
https://github.com/MEF-GIT/MEF-LSO-Cantata-SDK-extended
If you are a MEF Member, update your wiki profile with your GitHub account name. Access to the LSO Cantata SDK Extensions repository is periodically updated with provided GitHub accounts. Additionally contact the LSO Developer Community Manager to request the immediate access.
Are you a core contributor to this LSO SDK but not mentioned here? Please let the LSO Developer Community Manager know and we will add you!