You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It includes API definitions for the following functional areas:
4
5
5
-
This SDK release aligns the API schemas and definitions for Serviceability (Address Validation, Site Queries, Product Offering Qualification) and Product Inventory to the latest versions of MEF 79 and MEF 81 Draft Standards. In addition, the API schemas and definitions for Product Order are aligned with the new version of other Sonata APIs. The latest versions of MEF 79 and MEF 81 Draft Standards are included.
6
+
* Serviceability (Address, Service Site, and Product Offering Qualification Management)
7
+
* Product Quote
8
+
* Product Order
9
+
* Product Inventory
6
10
7
-
MEF LSO Sonata SDK includes API definitions for the following functional areas:
11
+
It also provides Product Specification for Access ELine as delivered by MEF W106
8
12
9
-
* Serviceability (Address, Service Site, and Product Offering Qualification Management)
10
-
* Product Quote
11
-
* Product Order
12
-
* Product Inventory
13
+
## High-level release notes
13
14
14
-
It also holds Payload Descriptions for the following structures that are used with these APIs
15
-
* JSON representations for Product Spec descriptions (initially for MEF Access E-Line services)
16
-
* JSON representations for the UNI attributes (sourced from MEF 57.1)
15
+
**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.
17
16
18
-
The MEF LSO Sonata SDK is released under the Apache 2.0 license.
17
+
**MEF W106 - LSO Sonata Product Specification - Access E-Line* which includes JSON schemas and the Requirements document.
18
+
19
+
* Update of all of LSO Sonata APIs:
20
+
* Use of TM Forum tooling based on Domain Context Specialization rules to ensure alignment with TM Forum APIs (see [MEF-TMF-ONAP-Collaboration](https://wiki.mef.net/pages/viewpage.action?pageId=106608028))
21
+
* Introduction of envelope-payload and product characteristic patterns as described in MEF W87
22
+
*[Bug fixes and improvements](https://.com/MEF-GIT/MEF-LSO-Sonata-SDK/projects/4)
23
+
24
+
* Static binding of envelope APIs with Product Specification payloads.
19
25
20
26
## Maturity Level
21
-
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.
27
+
28
+
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.
29
+
30
+
The maturity per functionality presents as follows:
31
+
32
+
* Address Validation, Site Query:
33
+
* Business Requirements
34
+
* MEF 79 - **Published Standard**
35
+
* MEF 79.0.1 - **undergoing Letter Ballot**
36
+
* Developer Guide - **none**
37
+
* API - **work in progress**
38
+
* Product Offering Qualification:
39
+
* Business Requirements - MEF 79 - **Published Standard**
40
+
* Developer Guide - MEF W87 - **work in progress - closed resolution of CfC#1**
41
+
* API - MEF W87 - **work in progress - closed resolution of CfC#1**
42
+
* Quote:
43
+
* Business Requirements - MEF W80 - **Draft (R7)**
44
+
* Developer Guide - **open project, not yet included**
45
+
* API - **work in progress, aligned with MEF W80 Draft (R)**
46
+
* Order:
47
+
* Business Requirements - MEF 57.1 - **Published Standard** (the next version MEF W57.2 is being prepared)
48
+
* Developer Guide - **none**
49
+
* API - **work in progress**
50
+
* Inventory:
51
+
* Business Requirements - MEF 81, MEF 81.0.1 **Published Standard**
52
+
* Developer Guide - **none**
53
+
* API - **work in progress**
54
+
55
+
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 MEF WIKI.
22
56
23
57
## Contents
24
58
25
59
This SDK contains the following items:
26
60
27
-
* COPYRIGHT - Copyright 2019 MEF Forum
28
-
* LICENSE - Contains a copy of the Apache 2.0 license
29
-
* README - This file
30
-
* payload_description - Common descriptors are found in this directory
* api - Definitions of the API are found in this directory
33
-
* Inventory - Contains the API definitions necessary for inter-carrier retrieval of Product Inventory
34
-
* Quote - Contains the API definitions for inter-carrier service quotation capability
35
-
* Serviceability - Contains the API definitions that allow the Service Provider, or Buyer to:
36
-
* Retrieve Address information including exact formats for Addresses known to the Seller
37
-
* Retrieve Service Site information including exact formats for Service Sites known to the Seller
38
-
* Determine whether it is feasible for the Seller to deliver a particular Product with a given configuration to a particular geographic location if applicable.
39
-
* ProductOrder - Contains the API definitions for inter-carrier service ordering capability.
40
-
* documentation - This contains the draft standards of the Business Requirements and Use Cases for
41
-
* Address, Service Site, and Product Offering Qualification Management (MEF 79 Draft (R3))
All superseded files can be found in the Git history, if needed.
61
+
*`COPYRIGHT` - Copyright 2020 MEF Forum
62
+
*`LICENSE` - Contains a copy of the Apache 2.0 license
63
+
*`README` - This file
64
+
*`api` - Definitions of the API are found in this directory
65
+
*`inventory` - Contains the API definitions necessary for inter-carrier retrieval of Product Inventory
66
+
*`order` - Contains the API definitions for inter-carrier service ordering capability.
67
+
*`quote` - Contains the API definitions for inter-carrier service quotation capability
68
+
*`serviceability` - Contains the APIs that allow the Service Provider or Buyer to perform:
69
+
*`address` - Retrieve Address information including exact formats for Addresses known to the Seller
70
+
*`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.
71
+
*`site` - Retrieve Service Site information including exact formats for Service Sites known to the Seller
72
+
*`doc` - All related standards and Developer Guides.
73
+
*`product/carrierEthernet/accessELine` - Contains reference JSON schemas for Access ELine delivered by MEF W106
*`standards` - The rest of documents and standards.
76
+
*`uml` - A collection of UML diagrams generated from all of the API files.
77
+
*`staticBinding` - Contains static bindings of envelope APIs with Product Specification payloads. It comes in OpenAPI 3.0.
78
+
79
+
**NOTE:** Please note the Readme files in particular directories that provide more detailed information about corresponding functionalities.
80
+
81
+
All superseded files can be found in the Git history if needed.
46
82
47
83
## Precedents
48
-
Any developer intending to use the materials in this repository should first thoroughly read, review and understand the following materials:
49
-
*[MEF 55: Lifecycle Service Orchestration (LSO): Reference Architecture and Framework](documentation/MEF%2055%20-%20LSO%20Reference%20Architecture%20and%20Framework.pdf) This document is a ratified MEF standard.
50
-
*[MEF 55.0.1: Amendment to MEF 55: Operational Threads](documentation/MEF%2055.0.1%20-%20Operational%20Threads.pdf) This document is a ratified MEF standard.
51
-
*[MEF 55.0.2: Amendment to MEF 55: TOSCA Services Templates](documentation/MEF%2055.0.2%20-%20TOSCA%20Service%20Templates.pdf) This document is a ratified MEF standard.
52
-
*[MEF 50.1: MEF Services Lifecycle Process Flows](documentation/MEF%2050.1%20-%20MEF%20Services%20Lifecycle%20Process%20Flows.pdf) This document is a ratified MEF standard.
53
-
*[MEF 79 Draft (R3): Address, Service Site, and Product Offering Qualification Management](documentation/MEF%2079%20Draft%20(R3)%20-%20Address%2C%20Service%20Site%2C%20and%20Product%20Offering%20Qualification%20Management.pdf)
*[MEF 57.1: Ethernet Ordering Technical Standard - Business Requirements and Use Cases](documentation/MEF%2057.1%20-%20Ethernet%20Ordering%20Technical%20Specification%20-%20Business%20Requirements%20and%20Use%20Cases.pdf) This document is a ratified MEF standard.
57
84
58
-
## Reference Implementations
85
+
Any developer intending to use the materials in this repository should first thoroughly read, review, and understand the following materials:
59
86
60
-
**1) LSO Sonata APIs (older version) implementation on Buyer side - contributed by Amdocs**
87
+
*[MEF 55: Lifecycle Service Orchestration (LSO): Reference Architecture and Framework](doc/standards/MEF%2055%20-%20LSO%20Reference%20Architecture%20and%20Framework.pdf) This document is a ratified MEF standard.
88
+
*[MEF 55.0.1: Amendment to MEF 55: Operational Threads](doc/standards/MEF%2055.0.1%20-%20Operational%20Threads.pdf) This document is a ratified MEF standard.
89
+
*[MEF 55.0.2: Amendment to MEF 55: TOSCA Services Templates](doc/standards/MEF%2055.0.2%20-%20TOSCA%20Service%20Templates.pdf) This document is a ratified MEF standard.
90
+
*[MEF 50.1: MEF Services Lifecycle Process Flows](doc/standards/MEF%2050.1%20-%20MEF%20Services%20Lifecycle%20Process%20Flows.pdf) This document is a ratified MEF standard.
91
+
*[MEF 57.1: Ethernet Ordering Technical Standard - Business Requirements and Use Cases](doc/standards/MEF%2057.1%20-%20Ethernet%20Ordering%20Technical%20Specification%20-%20Business%20Requirements%20and%20Use%20Cases.pdf) This document is a ratified MEF standard.
92
+
*[MEF 79: Address, Service Site, and Product Offering Qualification Management](doc/standards/MEF%2079%20-%20Address,%20Service%20Site,%20and%20Product%20Offering%20Qualification%20Management.pdf) This document is a ratified MEF standard.
93
+
*[MEF 79.0.1 (LB) - Amendment to MEF 79 Address, Service Site, and Product Offering Qualification Management Requirements and Use Cases](doc/standards/MEF%2079.0.1%20(LB)%20-%20Amendment%20to%20MEF%2079%20Address,%20Service%20Site,%20and%20Product%20Offering%20Qualification%20Management%20Requirements%20and%20Use%20Cases.pdf)
The example implementation of MEF LSO Sonata APIs on Buyer side provided by Amdocs. This example code is part of the solution between a Tier1 North American operator, Amdocs and a UK provider that was put into production in April 2019 to enable the automated ordering of Ethernet services.
63
-
64
-
This LSO Sonata reference implementation is available on for MEF Members:
**NOTE:** If you are a MEF Member, please update your MEF wiki profile with your account name. Access to this repository is periodically updated with provided accounts. Additionally contact the [LSO Developer Community Manager](mailto:[email protected]) to request the immediate access.
69
-
70
-
**NOTE:** This example LSO Sonata implementation does not provide an executable or runnable project and it is based on the older APIs version published in the "2018-dev-preview" release of the LSO Sonata SDK which is available here:
Questions and feedback should be asked either at [Sonata SDK Community](https://.com/orgs/MEF-GIT/teams/mef-lso-sonata-sdk-community) or directly to [email protected].
72
104
73
-
## Questions and Feedback
74
-
Questions and Feedback should be directed to [email protected]. 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.
105
+
**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.
75
106
76
-
# Disclaimer & Copyright
107
+
The MEF LSO Sonata SDK is released under the Apache 2.0 license.
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.
79
116
@@ -87,6 +124,4 @@ The receipt or any use of this document or its contents does not in any way crea
87
124
88
125
(c) any form of relationship between any MEF member and the recipient or user of this document.
89
126
90
-
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.
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.
0 commit comments