Skip to content

Releases: MEF-GIT/MEF-LSO-Legato-SDK

Mplify-LSO-Legato-SDK Janis Release

11 Jul 16:13

Choose a tag to compare

Download Link

Download the entire repository by clicking
here

Introduction

All references to 'MEF Forum' or 'MEF' in the release documentation, links, and
YAML files should be interpreted as references to 'Mplify Alliance' and
'Mplify' respectively. Since this release coincides with the transition of the
name of MEF Forum to Mplify Alliance, changes were not made to all the files in
this release. Standards that were already published will retain the "MEF" name.

Overview

This repository contains the release of the Legato SDK. The SDK includes APIs
for Service Order, Service Inventory, Performance Monitoring, and Streaming
Management functions of the Service Orchestration Functionality (SOF) at the
LSO Legato Interface Reference Point (IRP) as defined in the Mplify LSO
Reference Architecture.

Also included are Service schemas and Performance Monitoring definitions.

High-level release notes

  • Updated documents:

    • Mplify W99.1 - LSO Service Ordering Management API - Developer Guide
    • Mplify 101 - LSO Carrier Ethernet Service Schemas and Developer Guide
    • Mplify 133.1 - Draft Release 1 Allegro, Interlude and Legato Fault
      Management and Performance Monitoring BR&UC
    • Mplify W135.1 - LSO Service Inventory Management API - Developer Guide
    • Mplify 136.1 - Draft Release 1 Allegro, Interlude and Legato Service
      Function Testing Business Requirements & Use Cases
    • MEF W143 - LSO Allegro, LSO Interlude and LSO Legato Performance Monitoring
      API - Developer Guide
    • Mplify W146 - LSO Allegro, LSO Interlude and LSO Legato Threshold Crossing
      Alerts API and Developer Guide - Developer Guide
    • MEF W148 - LSO Allegro, LSO Interlude and LSO Legato Fault Management API -
      Developer Guide
    • Mplify W149 - LSO Allegro, LSO Interlude and LSO Legato Service Function
      Testing API - Developer Guide
  • No new Documents:

Scope

It includes API definitions for the following functional areas:

  • Service Catalog - This includes support for
    • 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 - This includes support for
    • Service Order/OrderItem - Create and Retrieve operations only
    • Not in scope
      • Service Order/OrderItem - Amend/Modify/Cancel, Delete operations
  • Service Inventory - This includes support for
    • Service - Retrieve operations only
    • Not in scope
      • Service - Create, Amend/Modify, Delete operations
  • Alarm Management
  • Fault Management
  • Performance Monitoring
  • Service Function Testing
  • Streaming Management

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

  • SD-WAN Services
  • Carrier Ethernet Services
  • L1 Connectivity Services
  • IP/IP-VPN Services

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

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

https://wiki.mplify.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 or draft standards that
have not yet completed the review cycles and approvals necessary to achieve the
status as a Mplify standard. Mplify is making these publicly available at this
time to invite wider industry review.

The maturity per functionality is presented as follows:

(*) is used to mark an item that changes its maturity compared to the previous
release.

APIs and Developer Guides:

  • Service Catalog API - early draft version, on hold, not to be used
  • *Mplify W99.1 - LSO Service Ordering Management API - Developer Guide -
    Done. Ready for Letter Ballot
  • *Mplify W135.1 - LSO Legato Service Inventory Management API - Developer
    Guide - Done. Ready for Letter Ballot

Service Schemas:

  • SD-WAN (MEF W100) - work in progress - CfC#2
  • *Carrier Ethernet (Mplify W101) - Done. Ready for Letter Ballot
  • Internet Protocol (MEF W102) - work in progress - CfC#4
  • LSO Legato Service Provisioning Specification - L1 (MEF W103) - work in
    progress - ready for CfC#1

SOAM:

  • Mplify *W133.1 - Allegro, Interlude and Legato Fault Management and
    Performance Monitoring BR&UC - Draft Release 2

  • Mplify *W136.1 - Service Function Testing Business Requirements and Use
    Cases - Draft Release 2

  • Mplify *W143 - Performance Monitoring API and Developer Guide - work in
    progress - CfC#4

  • Mplify *W146 - LSO Allegro, LSO Interlude and LSO Legato Threshold Crossing
    Alerts API and Developer Guide - Developer Guide - work in progress - ready
    for CfC#2

  • Mplify W147 - Streaming Management API and Developer Guide - Done. Ready
    for Letter Ballot

  • Mplify *W148 - LSO Allegro, LSO Interlude and LSO Legato Fault Management
    API - Developer Guide - work in progress - ready for CfC#2

  • Mplify *W149 - LSO Allegro, LSO Interlude and LSO Legato Service Function
    Testing API - Developer Guide - work in progress - ready for CfC#2

  • Mplify W153 - LSO IP Schemas and Developer Guide for SOAM early draft
    version, schemas only

  • Security:

    • MEF 128.1 - Published Standard

Contents

This SDK contains the following items:

  • COPYRIGHT - Copyright 2025 Mplify Forum
  • LICENSE - Contains a copy of the Apache 2.0 license
  • README - This file
  • serviceApi - Definitions of the APIs are found in this directory, provided
    as yaml files.
  • schema - Contains JSON schema files for service specifications.
  • documentation - documentation including API/Schema developer guides and
    openapi-tools generated API descriptions in markdown format
    • supportingStandards - The rest of the documents and standards.
  • generated
    • security - A not normative version of the standard APIs including the
      security profiles as required by MEF 128.1. Provided for evaluation.

Issues, questions, and Feedback

Issues should be reported with the use of GitHub issues. Questions and feedback
should be asked either at
Legato SDK Discussions
or directly to [email protected].

Reference Implementations

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

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

Copyright

© Mplify Alliance 2025. 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 Mplify Alliance
(Mplify) is not responsible for any errors. Mplify does not assume
responsibility to update or correct any information in this publication. No
representation or warranty, expressed or implied, is made by Mplify concerning
the completeness, accuracy, or applicability of any information contained
herein and no liability of any kind shall be assumed by Mplify 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. Mplify 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 Mplify
    member which are or may be associated with the ideas, techniques, concepts or
    expressions contained herein; nor

  • (b) any warranty or representation that any Mplify 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 Mplify member and the recipient or
    user of this document.

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

MEF-LSO-Legato-SDK Irene Release

16 Jan 13:45

Choose a tag to compare

Download Link

Download the entire repository by clicking
here

Overview

This repository contains the release of the Legato SDK. The SDK includes APIs
for Service Catalog, Service Order, Service Inventory, Performance Monitoring,
and Streaming Management functions of the Service Orchestration Functionality
(SOF) at the LSO Legato Interface Reference Point (IRP) as defined in the MEF
LSO Reference Architecture.

Also included are Service schemas and Performance Monitoring definitions.

High-level release notes

  • Updated documents:
    • MEF W99.1 - LSO Service Ordering Management API - Developer Guide
    • MEF W101 - LSO Carrier Ethernet Service Schemas and Developer Guide
    • MEF 133.1 - Draft Release 1 Allegro, Interlude and Legato Fault Management
      and Performance Monitoring BR&UC
    • MEF W135.1 - LSO Service Inventory Management API - Developer Guide
    • MEF 136.1 - Draft Release 1 Allegro, Interlude and Legato Service Function
      Testing Business Requirements & Use Cases
    • MEF W143 - LSO Allegro, LSO Interlude and LSO Legato Performance Monitoring
      API - Developer Guide
  • New Documents:
    • MEF W103 - LSO L1 Service Schemas and Developer Guide
    • MEF W146 - LSO Allegro, LSO Interlude and LSO Legato Threshold Crossing
      Alerts API and Developer Guide - Developer Guide
    • MEF W148 - LSO Allegro, LSO Interlude and LSO Legato Fault Management API -
      Developer Guide
    • MEF W149 - LSO Allegro, LSO Interlude and LSO Legato Service Function
      Testing API - Developer Guide
    • MEF W153 - LSO IP Schemas and Developer Guide for SOAM

Scope

It includes API definitions for the following functional areas:

  • Service Catalog - This includes support for
    • 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 - This includes support for
    • Service Order/OrderItem - Create and Retrieve operations only
    • Not in scope
      • Service Order/OrderItem - Amend/Modify/Cancel, Delete operations
  • Service Inventory - This includes support for
    • Service - Retrieve operations only
    • Not in scope
      • Service - Create, Amend/Modify, Delete operations
  • Alarm Management
  • Fault Management
  • Performance Monitoring
  • Service Function Testing
  • Streaming Management

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
  • IP/IP-VPN Services

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

More information about the LSO Legato API reference point and its 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 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 is presented as follows:

(*) is used to mark an item that changes its maturity compared to the previous
release.

APIs and Developer Guides:

  • Service Catalog API - early draft version, on hold
  • *MEF W99.1 - LSO Service Ordering Management API - Developer Guide - work
    in progress - ready for CfC#1
  • *MEF W135.1 - LSO Legato Service Inventory Management API - Developer
    Guide -work in progress - ready for CfC#1

Service Schemas:

  • SD-WAN (MEF W100) - work in progress - CfC#2
  • *Carrier Ethernet (MEF W101) - work in progress - CfC#3
  • Internet Protocol (MEF W102) - work in progress - CfC#4
  • *LSO Legato Service Provisioning Specification - L1 (MEF W103) - work in
    progress - ready for CfC#1

SOAM:

  • MEF *W133.1 - Allegro, Interlude and Legato Fault Management and Performance
    Monitoring BR&UC - Draft Release 1

  • MEF *W136.1 - Service Function Testing Business Requirements and Use Cases -
    Draft Release 1

  • MEF W143 - Performance Monitoring API and Developer Guide - work in
    progress - CfC#3

  • MEF *W146 - LSO Allegro, LSO Interlude and LSO Legato Threshold Crossing
    Alerts API and Developer Guide - Developer Guide - work in progress - ready
    for CfC#1

  • MEF *W147 - Streaming Management API and Developer Guide - work in
    progress - CfC#2

  • MEF *W148 - LSO Allegro, LSO Interlude and LSO Legato Fault Management API -
    Developer Guide - work in progress - ready for CfC#1

  • MEF *W149 - LSO Allegro, LSO Interlude and LSO Legato Service Function
    Testing API - Developer Guide - work in progress - ready for CfC#1

  • MEF *W153 - LSO IP Schemas and Developer Guide for SOAM early draft
    version, schemas only

  • Security:

    • MEF 128.1 - Published Standard

Contents

This SDK contains the following items:

  • COPYRIGHT - Copyright 2024 MEF Forum
  • LICENSE - Contains a copy of the Apache 2.0 license
  • README - This file
  • serviceApi - Definitions of the APIs are found in this directory, provided
    as yaml files.
  • serviceSchema - Contains JSON schema (draft 7) files for service
    specifications.
  • documentation - documentation including API/Schema developer guides and
    openapi-tools generated API descriptions in markdown format
    • supportingStandards - The rest of the documents and standards.
  • generated
    • staticBinding - No longer provided - please visit
      LSO Marketplace to use self-blending possibility.
    • security - A not normative version of the standard APIs including the
      security profiles as required by MEF 128.1. Provided for evaluation.

Issues, questions, and Feedback

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

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

Copyright

© MEF Forum 2025. 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.

MEF LSO Legato SDK Haley Release

20 Jun 08:36

Choose a tag to compare

Download Link

Download the entire repository by clicking here

Overview

This repository contains the release of the Legato SDK. The SDK includes APIs for Service Catalog, Service Order, Service Inventory, Performance Monitoring, and Streaming Management functions of the Service Orchestration Functionality (SOF) at the LSO Legato Interface Reference Point (IRP) as defined in the MEF LSO Reference Architecture.

Also included are Service schemas and Performance Monitoring definitions.

High-level release notes

  • Updated documents:
    • MEF 128.1 - LSO API Security Profile

Scope

It includes API definitions for the following functional areas:

  • Service Catalog - This includes support for
    • 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 - This includes support for
    • Service Order/OrderItem - Create and Retrieve operations only
    • Not in scope
      • Service Order/OrderItem - Amend/Modify/Cancel, Delete operations
  • Service Inventory - This includes support for
    • Service - Retrieve operations only
    • Not in scope
      • Service - Create, Amend/Modify, Delete operations
  • Performance Monitoring
  • Streaming Management

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
  • IP/IP-VPN Services

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

More information about the LSO Legato API reference point and its 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 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 is presented as follows:

(*) is used to mark an item that changes its maturity compared to the previous release.

APIs and Developer Guides:

  • Service Catalog API - early draft version, on hold
  • MEF 99 - LSO Service Ordering Management API - Developer Guide W99 - Published Standard
  • MEF 135 - LSO Legato Service Inventory Management API - Developer Guide - Published Standard

Service Schemas:

  • SD-WAN (MEF W100) - work in progress - CfC#2
  • Carrier Ethernet (MEF W101) - work in progress - CfC#2
  • Internet Protocol (MEF W102) - work in progress - CfC#4
  • LSO Legato Service Provisioning Specification - L1 (MEF W103) - work in progress - CfC#3 - on hold

SOAM:

  • MEF 133 - Allegro, Interlude and Legato Fault Management and Performance Monitoring BR&UC - Published Standard

  • MEF W133.1 - Allegro, Interlude and Legato Fault Management and Performance Monitoring BR&UC - early draft version, CfC#1

  • MEF 136 - Service Function Testing Business Requirements and Use Cases - Published Standard

  • MEF W143 - Performance Monitoring API and Developer Guide - work in progress - CfC#2

  • MEF W147 - Streaming Management API and Developer Guide - work in progress - CfC#2

  • Performance Monitoring reports and statistics definitions for Carrier Ethernet and IP - early draft version, schemas only

  • Security:

    • *MEF 128.1 - Published Standard

Contents

This SDK contains the following items:

  • COPYRIGHT - Copyright 2024 MEF Forum
  • LICENSE - Contains a copy of the Apache 2.0 license
  • README - This file
  • serviceApi - Definitions of the APIs are found in this directory, provided as yaml files.
  • serviceSchema - Contains JSON schema (draft 7) files for service specifications.
  • documentation - documentation including API/Schema developer guides and openapi-tools generated API descriptions in markdown format
    • supportingStandards - The rest of the documents and standards.
  • generated
    • staticBinding - No longer provided - please visit
      LSO Marketplace to use self-blending possibility.
    • security - A not normative version of the standard APIs including the
      security profiles as required by MEF 128.1. Provided for evaluation.

Issues, questions, and Feedback

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

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

Copyright

© MEF Forum 2024. 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.

MEF LSO Legato SDK Grace Release

20 Dec 12:02

Choose a tag to compare

Download Link

Download the entire repository by clicking here

Overview

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

Also included are Service schemas and Performance Monitoring definitions .

High-level release notes

  • Internet Protocol schemas are revised and updated, together with their guide documents (MEF W102)
  • Following documents have been published as MEF Standards:
    • MEF 99 - LSO Service Ordering Management API - Developer Guide
    • MEF 135 - LSO Legato Service Inventory Management API - Developer Guide
  • New document:
    • MEF 55.1.1 Amendment to MEF 55.1: Reference Architecture and Framework - Terminology
  • Updated documents:
    • MEF W128.1 - LSO API Security Profile
    • MEF W133.1 - Allegro, Interlude and Legato Fault Management and Performance Monitoring BR&UC
    • MEF W143 - Performance Monitoring API and Developer Guide
    • MEF W147 - Streaming Management API and Developer Guide

Scope

It includes API definitions for the following functional areas:

  • Service Catalog - This includes support for
    • 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 - This includes support for
    • Service Order/OrderItem - Create, Retrieve operations only
    • Not in scope
      • Service Order/OrderItem - Amend/Modify/Cancel, Delete operations
  • Service Inventory - This includes support for
    • Service - Retrieve operations only
    • Not in scope
      • Service - Create, Amend/Modify, Delete operations

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
  • IP/IP-VPN 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 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:

(*) is used to mark item that changes their maturity comparing to previous release.

APIs and Developer Guides:

  • Service Catalog API - early draft version, on hold
  • MEF 99 - LSO Service Ordering Management API - Developer Guide W99 - Published Standard
  • MEF 135 - LSO Legato Service Inventory Management API - Developer Guide - Published Standard

Service Schemas:

  • SD-WAN (MEF W100) - work in progress - CfC#2
  • Carrier Ethernet (MEF W101) - work in progress - CfC#2
  • *Internet Protocol (MEF W102) - work in progress - CfC#4
  • LSO Legato Service Provisioning Specification - L1 (MEF W103) - work in progress - CfC#3 - on hold

SOAM:

  • MEF 133 - Allegro, Interlude and Legato Fault Management and Performance Monitoring BR&UC - Published Standard
  • *MEF W133.1 - Allegro, Interlude and Legato Fault Management and Performance Monitoring BR&UC - early draft version, CfC#1
  • MEF 136 - Service Function Testing Business Requirements and Use Cases - Published Standard
  • *MEF W143 - Performance Monitoring API and Developer Guide - work in progress - CfC#2
  • *MEF W147 - Streaming Management API and Developer Guide - work in progress - CfC#2
  • Performance Monitoring reports and statistics definitions for Carrier Ethernet adn IP - early draft version, schemas only

Contents

This SDK contains the following items:

  • COPYRIGHT - Copyright 2023 MEF Forum
  • LICENSE - Contains a copy of the Apache 2.0 license
  • README - This file
  • serviceApi - Definitions of the APIs are found in this directory, provided as yaml files.
  • serviceSchema - Contains JSON schema (draft 7) files for service specifications.
  • documentation - documentation including API/Schema developer guides and openapi-tools generated API descriptions in markdown format
    • supportingStandards - The rest of documents and standards.
  • generated - No longer provided - please visit LSO Marketplace to use self-blending possibility.

Issues, questions, and Feedback

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

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

Copyright

© MEF Forum 2023. 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.

MEF-LSO-Legato-SDK Fergie Release

23 Jun 14:18

Choose a tag to compare

Download Link

Download the entire repository by clicking here

Overview

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

Also included are Service schemas and Performance Monitoring definitions.

High-level release notes

  • SD-WAN service schemas are revised and updated, together with their guide documents (MEF W100)
  • Following documents have been published as MEF Standards:
    • MEF 133 - Allegro, Interlude and Legato Fault Management and Performance Monitoring BR&UC
    • MEF 136 - Service Function Testing Business Requirements and Use Cases
  • New document:
    • MEF W128.1 - LSO API Security Profile
    • MEF W133.1 - Allegro, Interlude and Legato Fault Management and Performance Monitoring BR&UC

Scope

It includes API definitions for the following functional areas:

  • Service Catalog - This includes support for
    • 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 - This includes support for
    • Service Order/OrderItem - Create, Retrieve operations only
    • Not in scope
      • Service Order/OrderItem - Amend/Modify/Cancel, Delete operations
  • Service Inventory - This includes support for
    • Service - Retrieve operations only
    • Not in scope
      • Service - Create, Amend/Modify, Delete operations

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
  • IP/IP-VPN 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 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:

(*) is used to mark item that changes their maturity comparing to previous release.

APIs and Developer Guides:

  • Service Catalog API - early draft version, on hold
  • MEF W99 - LSO Service Ordering Management API - Developer Guide W99 - work in progress - requested LB
  • MEF W135 - LSO Legato Service Inventory Management API - Developer Guide - work in progress - requested LB

Service Schemas:

  • *SD-WAN (MEF W100) - work in progress - CfC#2
  • Carrier Ethernet (MEF W101) - work in progress - CfC#2
  • Internet Protocol (MEF W102) - work in progress - CfC#2
  • LSO Legato Service Provisioning Specification - L1 (MEF W103) - work in progress - CfC#3 - on hold

SOAM:

  • *MEF 133 - Allegro, Interlude and Legato Fault Management and Performance Monitoring BR&UC - Published Standard
  • *MEF W133.1 - Allegro, Interlude and Legato Fault Management and Performance Monitoring BR&UC - early draft version
  • *MEF 136 - Service Function Testing Business Requirements and Use Cases - Published Standard
  • *MEF W143 - Performance Monitoring Profiles, Jobs, Notifications and Collection API and Developer Guide - work in progress - CfC#1
  • *MEF W147 - Streaming Management API and Developer Guide - work in progress - CfC#1
  • Performance Monitoring reports and statistics definitions for Carrier Ethernet adn IP - early draft version

Contents

This SDK contains the following items:

  • COPYRIGHT - Copyright 2023 MEF Forum
  • LICENSE - Contains a copy of the Apache 2.0 license
  • README - This file
  • serviceApi - Definitions of the APIs are found in this directory, provided as yaml files.
  • serviceSchema - Contains JSON schema (draft 7) files for service specifications.
  • documentation - documentation including API/Schema developer guides and openapi-tools generated API descriptions in markdown format
    • supportingStandards - The rest of documents and standards.
  • generated
    • staticBinding - No longer provided - please visit LSO Marketplace to use self-blending possibility.
    • security - A not normative version of the standard APIs including the security profiles as required by MEF 128. Provided for evaluation.

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 [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.

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

Copyright

© MEF Forum 2023. 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.

MEF-LSO-Legato-SDK Ella Release

06 Jan 00:08

Choose a tag to compare

Download Link

Download the entire repository by clicking here

Overview

This repository contains the release of the Legato SDK. The SDK includes APIs 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.

Also included are draft, in-progress versions of the API Developer Guides for each of the service types listed above.

High-level release notes

  • Service Ordering and Service Inventory APIs are updated to match all Sonata API patterns and have API Developer Guide documents provided (MEF W99 and MEF W135).
  • Carrier Ethernet and IP service schemas are revised and updated, together with their guide documents (MEF W101, MEF W102)
  • Following documents have been published as MEF Standards:
    • MEF 112 - Draft Release 1 MEF Services Model Information Model for IP and IP VPN
    • MEF 128 - Draft Release 2 LSO API Security Profile
  • New document:
    • MEF W133 - Allegro, Interlude and Legato Fault Management and Performance Monitoring BR&UC

Scope

It includes API definitions for the following functional areas:

  • Service Catalog - This includes support for
    • 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 - This includes support for
    • Service Order/OrderItem - Create, Retrieve operations only
    • Not in scope
      • Service Order/OrderItem - Amend/Modify/Cancel, Delete operations
  • Service Inventory - This includes support for
    • Service - Retrieve operations only
    • Not in scope
      • Service - Create, Amend/Modify, Delete operations
  • Service Notification - This includes support for
    • 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
  • IP/IP-VPN 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 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 Ordering Management API (MEF W99) - work in progress - ready for CfC#2
  • *LSO Legato Service Inventory Management API - Developer Guide (MEF W135) - work in progress - ready for CfC#2
  • LSO Legato Service Provisioning Specification - SD-WAN (MEF W100) - DRAFT version
  • *LSO Legato Carrier Ethernet Service Schemas and Developer Guide (MEF W101) - work in progress - ready for CfC#2
  • *LSO Legato Internet Protocol Service Schemas and Developer Guide (MEF W102) - work in progress - ready for CfC#2
  • LSO Legato Service Provisioning Specification - L1 (MEF W103) - DRAFT version

(*) is used to mark item that changes their maturity comparing to previous release.

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
  • serviceApi - Definitions of the APIs are found in this directory, provided as yaml files.
  • serviceSchema - Contains JSON schema (draft 7) files for service specifications.
  • documentation - documentation including API/Schema developer guides and openapi-tools generated API descriptions in markdown format
    • supportingStandards - The rest of documents and standards.
  • generated
    • staticBinding - No longer provided - please visit LSO Marketplace to use self-blending possibility.
    • security - A not normative version of the standard APIs including the security profiles as required by MEF 128. Provided for evaluation.

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 [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.

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

Copyright

© MEF Forum 2023. 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.

MEF-LSO-Legato-SDK Dolly Release

08 Jun 16:38

Choose a tag to compare

Download Link

Download the entire repository by clicking here

Overview

This repository contains the Dolly release of the Legato SDK. The SDK includes APIs 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.

Also included are draft, in-progress versions of the API Developer Guides for each of the service types listed above.

High-level release notes

  • New documents:
    • MEF W112 - Draft Release 1 MEF Services Model Information Model for IP and IP VPN
    • MEF W128 - Draft Release 2 LSO API Security Profile

Scope

It includes API definitions for the following functional areas:

  • Service Catalog - This includes support for
    • 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 - This includes support for
    • Service Order/OrderItem - Create, Retrieve operations only
    • Not in scope
      • Service Order/OrderItem - Amend/Modify/Cancel, Delete operations
  • Service Inventory - This includes support for
    • Service - Retrieve operations only
    • Not in scope
      • Service - Create, Amend/Modify, Delete operations
  • Service Notification - This includes support for
    • 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
  • IP/IP-VPN 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 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 (DRAFT, part of this SDK release)
    • API Developer Guide as GFM file (DRAFT, part of this SDK release)
  • LSO Legato Service Provisioning Specification - SD-WAN (MEF W100)
    • JSON Schema definitions as YAML files (DRAFT, part of this SDK release)
    • Schema Guide as GFM file (DRAFT, part of this SDK release)
  • LSO Legato Service Provisioning Specification - Carrier Ethernet (MEF W101)
    • JSON Schema definitions as YAML files (DRAFT, part of this SDK release)
    • Schema Guide as GFM file (DRAFT, part of this SDK release)
  • LSO Legato Service Provisioning Specification - L1 (MEF W103)
    • JSON Schema definitions as YAML files (DRAFT, part of this SDK release)
    • Schema Guide as GFM file (DRAFT, part of this SDK release)

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
  • serviceApi - Definitions of the API are found in this directory
    • catalog - Contains the API definitions for querying and retrieving Service-Specification instances from the service catalog system in the SOF.
    • inventory - Contains the API definitions for querying and retrieving Service instances from the service inventory system in the SOF.
    • order - 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.
    • common - 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.
  • serviceSchema - Contains JSON schema (draft 7) files for
    • SD-WAN Services
    • Carrier Ethernet Services
    • L1 Connectivity Services.
    • IP/IP-VPN Services
  • documentation - documentation including API/Schema developer guides and openapi-tools generated API descriptions in markdown format
    • supportingStandards - The rest of documents and standards.
  • generated\staticBinding - contains automatically generated (with help of the open source Sonata Blending Tool), not normative static bindings of envelope APIs with Service payloads.

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 [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.

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

Copyright

© MEF Forum 2022. 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.

MEF-LSO-Legato-SDK Celine Release

14 Jan 19:45

Choose a tag to compare

Download Link

Download the entire repository by clicking here

Overview

This repository contains the Celine release of the Legato SDK. The SDK includes APIs 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:

  • IP/IP-VPN (based on MEF 112)

Also included are draft, in-progress versions of the API Developer Guides for each of the service types listed above.

NOTE: Some parts of the release are for MEF Members only, such as the draft, in-progress versions of the API Developer Guides for each of the service types listed above

Scope

It includes API definitions for the following functional areas:

  • Service Catalog - This includes support for
    • 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 - This includes support for
    • Service Order/OrderItem - Create, Retrieve operations only
    • Not in scope
      • Service Order/OrderItem - Amend/Modify/Cancel, Delete operations
  • Service Inventory - This includes support for
    • Service - Retrieve operations only
    • Not in scope
      • Service - Create, Amend/Modify, Delete operations
  • Service Notification - This includes support for
    • 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
  • IP/IP-VPN 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 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 (DRAFT, part of this SDK release)
    • API Developer Guide as GFM file (DRAFT, part of this SDK release)
  • LSO Legato Service Provisioning Specification - SD-WAN (MEF W100)
    • JSON Schema definitions as YAML files (DRAFT, part of this SDK release)
    • Schema Guide as GFM file (DRAFT, part of this SDK release)
  • LSO Legato Service Provisioning Specification - Carrier Ethernet (MEF W101)
    • JSON Schema definitions as YAML files (DRAFT, part of this SDK release)
    • Schema Guide as GFM file (DRAFT, part of this SDK release)
  • LSO Legato Service Provisioning Specification - L1 (MEF W103)
    • JSON Schema definitions as YAML files (DRAFT, part of this SDK release)
    • Schema Guide as GFM file (DRAFT, part of this SDK release)

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
  • serviceApi - Definitions of the API are found in this directory
    • catalog - Contains the API definitions for querying and retrieving Service-Specification instances from the service catalog system in the SOF.
    • inventory - Contains the API definitions for querying and retrieving Service instances from the service inventory system in the SOF.
    • order - 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.
    • common - 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.
  • serviceSchema - Contains JSON schema (draft 7) files for
    • SD-WAN Services
    • Carrier Ethernet Services
    • L1 Connectivity Services.
    • IP/IP-VPN Services
  • documentation - documentation including API/Schema developer guides and openapi-tools generated API descriptions in markdown format
  • generated\staticBinding - contains automatically generated (with help of the open source Sonata Blending Tool), not normative static bindings of envelope APIs with Service payloads.

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 [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.

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

Copyright

© MEF Forum 2022. 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.

MEF-LSO-Legato-SDK Billie Release

07 Jun 08:38

Choose a tag to compare

Download Link

Download the entire repository by clicking here

Overview

This repository contains the Billie release of the Legato SDK. The SDK includes APIs 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).

Also included are draft, in-progress versions of the API Developer Guides for each of the service types listed above.

Scope

It includes API definitions for the following functional areas:

  • Service Catalog - This includes support for
    • 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 - This includes support for
    • Service Order/OrderItem - Create, Retrieve operations only
    • Not in scope
      • Service Order/OrderItem - Amend/Modify/Cancel, Delete operations
  • Service Inventory - This includes support for
    • Service - Retrieve operations only
    • Not in scope
      • Service - Create, Amend/Modify, Delete operations
  • Service Notification - This includes support for
    • 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 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 (DRAFT, part of this SDK release)
    • API Developer Guide as GFM file (To be delivered)
  • LSO Legato Service Provisioning Specification - SD-WAN (MEF W100)
    • JSON Schema definitions as YAML files (DRAFT, part of this SDK release)
    • Schema Guide as GFM file (DRAFT, part of this SDK release)
  • LSO Legato Service Provisioning Specification - Carrier Ethernet (MEF W101)
    • JSON Schema definitions as YAML files (DRAFT, part of this SDK release)
    • Schema Guide as GFM file (DRAFT, part of this SDK release)
  • LSO Legato Service Provisioning Specification - L1 (MEF W103)
    • JSON Schema definitions as YAML files (DRAFT, part of this SDK release)
    • Schema Guide as GFM file (DRAFT, part of this SDK release)

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
  • serviceApi - Definitions of the API are found in this directory
    • catalog - Contains the API definitions for querying and retrieving
      Service-Specification instances from the service catalog system in the SOF.
    • inventory - Contains the API definitions for querying and retrieving
      Service instances from the service inventory system in the SOF.
    • order - 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.
    • common - 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.
  • serviceSchema - Contains JSON schema (draft 7) files for
    • SD-WAN Services
    • Carrier Ethernet Services
    • L1 Connectivity Services.
  • documentation - documentation including API/Schema developer guides and openapi-tools generated API descriptions in markdown format
  • generated\staticBinding - contains automatically generated (with help of the open source Sonata Blending Tool), not normative static bindings of envelope APIs with Service payloads.

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 [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.

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

Copyright

© MEF Forum 2021. 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.

MEF-LSO-Legato-SDK Aretha Release

23 Dec 01:45

Choose a tag to compare

Pre-release

Download Link

Download the entire repository by clicking
here

Overview

This repository contains the Aretha release of the 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

It includes API definitions for the following functional areas:

  • Service Catalog - This includes support for
    • 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 - This includes support for
    • Service Order/OrderItem - Create, Retrieve operations only
    • Not in scope
      • Service Order/OrderItem - Amend/Modify/Cancel, Delete operations
  • Service Inventory - This includes support for
    • Service - Retrieve operations only
    • Not in scope
      • Service - Create, Amend/Modify, Delete operations
  • Service Notification - This includes support for
    • 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 [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.

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

An instance of the ONAP project may be provided in MEFnet for MEF members to undertake integration testing. Please see the MEFnet Terms of Use.

https://wiki.mef.net/display/CESG/MEFnet

https://mef.net/TOU

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

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.