The LSO Legato SDK is the complete set of deliverables developed by the MEF membership in order to

1. Enable market adoption of LSO Legato APIs in the current release of the LSO API Framework.
2. Support of development of additional features for the upcoming release of the LSO Legato SDK.

The latest release of LSO Legato SDK is in the LSO API Release 'Aretha' 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 Legato 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-Legato-SDK Aretha Release

Download Link

Download the entire repository by clicking here.

Overview

This repository contains the Aretha release of the LSO Legato SDK. The SDK includes Service Provisioning APIs describing the Application Programming Interfaces for Service Catalog, Service Order, Service Inventory and Service Notification functions of the Service Orchestration Functionality (SOF) at the LSO Legato Interface Reference Point (IRP) as defined in the MEF LSO Reference Architecture.

This version updates the payload schemas for:

• Carrier Ethernet (based on MEF 7.4),
• SD-WAN (based on MEF 82) and
• L1CS (based on MEF 111).

Future versions will include full API Developer Guides for each of the service types listed above.

Scope

API definitions for the following functional areas:

• Service Catalog
  
  • Included
    • Service Specification - Retrieve operations only
  • Not in scope
    • Service Specifications - Create, Amend/Modify, Delete operations
    • Service Catalog, Service Category, Service Candidate, Job/Task
• Service Ordering
  • Included
    
    • Service Order/OrderItem - Create, Retrieve operations only
  • Not in scope
    • Service Order/OrderItem - Amend/Modify/Cancel, Delete operations
• Service Inventory
  • Included
    
    • Service - Retrieve operations only
  • Not in scope
    • Service - Create, Amend/Modify, Delete operations
• Service Notification
  • Included
    
    • Hub - Create, Delete, Retrieve operations
    • Service Specification - Create, Delete, StateChange event notifications
    • Service Order/OrderItem - Create, StateChange event notifications
    • Service events - Create, Delete, StateChange event notifications
  • Not in scope
    • Hub - Modify operations
    • Retrieve Notification records history/log
    • AttributeValueChange event notifications

In addition to the Service Provisioning APIs, the SDK includes the following MEF Service Specification schemas:

• SD-WAN Services
• Carrier Ethernet Services
• L1 Connectivity Services

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

More information about the LSO Legato API reference point and it's roadmap can be found here:

https://wiki.mef.net/display/CESG/LSO+Legato

Maturity Level

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

There is currently LSO Legato Service Provisioning Project open that aims to deliver:

• LSO Legato Service Provisioning API (MEF W99)
  • OAS3 API/Schema definitions as YAML files (READY, part of this SDK release)
  • Developer Guide as GFM file (To be delivered)
• LSO Legato Service Provisioning Specification - SD-WAN (MEF W100)
  • JSON Schema definitions as YAML files (READY, part of this SDK release)
  • Requirements document as GFM file (To be delivered)
• LSO Legato Service Provisioning Specification - Carrier Ethernet (MEF W101)
  • JSON Schema definitions as YAML files (READY, part of this SDK release)
  • Requirements document as GFM file (To be delivered)
• LSO Legato Service Provisioning Specification - L1 (MEF W103)
  • JSON Schema definitions as YAML files (READY, part of this SDK release)
  • Requirements document as GFM file (To be delivered)

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\legato\serviceProvisioning - Definitions of the API are found in this directory
  • serviceCatalog - Contains the API definitions for querying and retrieving Service-Specification instances from the service catalog system in the SOF.
  • serviceInventory - Contains the API definitions for querying and retrieving Service instances from the service inventory system in the SOF.
  • serviceOrdering - Contains the API definitions for posting Service-Order request to the service order system in the SOF. Each Service-Order contains one or more Service-Order-Items, each of which specifies the Service instance (and its characteristics) to be added/updated/deleted.
  • serviceCommon - Contains the API definitions for registering Notification-Listeners to be called-back when the specified condition occurs. Also common API resources and error definition can be found here.
• doc – automatically generated documentation.
• spec – Contains OpenAPI 3.0 Specification files for SD-WAN,Carrier Ethernet Services and L1 Connectivity Services.

Issues, Questions, and Feedback

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

Reference Implementations

A reference implementation of the MEF Service Instantiation API may be available from the ONAP EXTAPI project.

https://wiki.onap.org/display/DW/External+API+Framework+Project

Related Projects

The MEF Legato IPS is based on ONAP EXternal API (Dublin) which can be found here:

https://docs.onap.org/en/latest/submodules/externalapi/nbi.git/docs/offeredapis/offeredapis.html

Source: LSO Legato Graphics