aretha

.project

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>MEF-LSO-Legato-Model</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+	</buildSpec>
+	<natures>
+	</natures>
+</projectDescription>

COPYRIGHT

@@ -1 +1 @@
-Copyright (C) 2019 MEF Forum
+Copyright (C) 2020 MEF Forum

README.md

@@ -1,8 +1,23 @@
-# MEF-LSO-Legato-SDK (RC4)
+# MEF-LSO-Legato-SDK Aretha Release
+
+## Download Link
+
+Download the entire repository by clicking
+[here](https://github.com/MEF-GIT/MEF-LSO-Legato-SDK/releases/download/aretha/MEF-LSO-Legato-SDK-aretha.zip)
 
 ## Overview
 
-This repository contains the Release Candidate 4 of the Legato SDK. The SDK includes Service Provisioning APIs describe 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 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:
 
@@ -67,11 +82,12 @@ This SDK contains the following items:
 * `COPYRIGHT` - Copyright 2020 MEF Forum
 * `LICENSE` - Contains a copy of the Apache 2.0 license
 * `README` - This file
-* `api` - Definitions of the API are found in this directory
+* `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

doc/api/legato/serviceProvisioning/serviceCatalog/v4/openapi/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

doc/api/legato/serviceProvisioning/serviceCatalog/v4/openapi/.openapi-generator/FILES

@@ -0,0 +1 @@
+schemas.plantuml

doc/api/legato/serviceProvisioning/serviceCatalog/v4/openapi/.openapi-generator/VERSION

@@ -0,0 +1 @@
+5.0.0-beta

doc/api/legato/serviceProvisioning/serviceCatalog/v4/openapi/Apis/EventSubscriptionHubApi.md

@@ -0,0 +1,90 @@
+# EventSubscriptionHubApi
+
+All URIs are relative to *https://mef.net:8443/mefApi/legato/serviceCatalog/v4*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**hubCreate**](EventSubscriptionHubApi.md#hubCreate) | **POST** /hub | Create Hub
+[**hubDelete**](EventSubscriptionHubApi.md#hubDelete) | **DELETE** /hub/{hubId} | Delete Hub
+[**hubGet**](EventSubscriptionHubApi.md#hubGet) | **GET** /hub/{hubId} | get hub
+
+
+<a name="hubCreate"></a>
+# **hubCreate**
+> EventSubscription hubCreate(eventSubscriptionInput)
+
+Create Hub
+
+    Structure used to create a hub (to subscribe to notification
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **eventSubscriptionInput** | [**EventSubscriptionInput**](../\Models/EventSubscriptionInput.md)|  |
+
+### Return type
+
+[**EventSubscription**](../\Models/EventSubscription.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json;charset=utf-8
+- **Accept**: application/json;charset=utf-8
+
+<a name="hubDelete"></a>
+# **hubDelete**
+> hubDelete(hubId)
+
+Delete Hub
+
+    Delete an existing Hub
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **hubId** | **String**|  | [default to null]
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json;charset=utf-8
+
+<a name="hubGet"></a>
+# **hubGet**
+> EventSubscription hubGet(hubId)
+
+get hub
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **hubId** | **String**|  | [default to null]
+
+### Return type
+
+[**EventSubscription**](../\Models/EventSubscription.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json;charset=utf-8
+

doc/api/legato/serviceProvisioning/serviceCatalog/v4/openapi/Apis/ServiceSpecificationApi.md

@@ -0,0 +1,69 @@
+# ServiceSpecificationApi
+
+All URIs are relative to *https://mef.net:8443/mefApi/legato/serviceCatalog/v4*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**serviceSpecificationFind**](ServiceSpecificationApi.md#serviceSpecificationFind) | **GET** /serviceSpecification | List service specifications
+[**serviceSpecificationGet**](ServiceSpecificationApi.md#serviceSpecificationGet) | **GET** /serviceSpecification/{id} | Retrieve a service specification
+
+
+<a name="serviceSpecificationFind"></a>
+# **serviceSpecificationFind**
+> List serviceSpecificationFind(category, lifecycleStatus, fields, offset, limit)
+
+List service specifications
+
+    This operation returns service specifications from a catalog
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **category** | **String**| Service Category | [optional] [default to null]
+ **lifecycleStatus** | [**ServiceSpecificationState**](../\Models/.md)| Service Specification status | [optional] [default to null] [enum: IN_STUDY, IN_DESIGN, IN_TEST, LAUNCHED, ACTIVE, RETIRED, OBSOLETE, REJECTED]
+ **fields** | **String**| Comma-separated properties of the Service Specification to be  included in the returned response | [optional] [default to null]
+ **offset** | **Integer**| Requested start index in a ordered list (sorted by id property) of  matching Service Specifications to be provided in response.  | [optional] [default to null]
+ **limit** | **Integer**| Requested maximum number of Service Specifications to be provided  in the response | [optional] [default to null]
+
+### Return type
+
+[**List**](../\Models/ServiceSpecification.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json;charset=utf-8
+
+<a name="serviceSpecificationGet"></a>
+# **serviceSpecificationGet**
+> ServiceSpecification serviceSpecificationGet(id, fields)
+
+Retrieve a service specification
+
+    This operation returns a service specification by its id from a catalog. Attribute selection is enabled using the fields attribute.
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Identifier of the ServiceSpecification | [default to null]
+ **fields** | **String**| Comma-separated properties of the Service Specification to be  included in the returned response | [optional] [default to null]
+
+### Return type
+
+[**ServiceSpecification**](../\Models/ServiceSpecification.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json;charset=utf-8
+

doc/api/legato/serviceProvisioning/serviceCatalog/v4/openapi/Models/Addressable.md

@@ -0,0 +1,14 @@
+# Addressable
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Attype** | [**String**](string.md) | The concrete (non-abstract) class type of the API schema object. | [default to null]
+**AtbaseType** | [**String**](string.md) | When sub-classing, this defines the super/base class type (if  applicable) of the API schema object. | [optional] [default to null]
+**AtschemaLocation** | [**URI**](URI.md) | A URI refernce to the schema file that defines the attributes and relationships of the API schema object. | [optional] [default to null]
+**id** | [**String**](string.md) | Unique identifier of the API schema object instance. The  ID is invariant and is assigned by the server. In other words  this entity will have the same ID throught its lifetime. | [default to null]
+**href** | [**URI**](URI.md) | URI reference of the API schema object instance. | [optional] [default to null]
+**name** | [**String**](string.md) | Name of the API schema object instance. | [optional] [default to null]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

doc/api/legato/serviceProvisioning/serviceCatalog/v4/openapi/Models/AddressableAllOf.md

@@ -0,0 +1,11 @@
+# AddressableAllOf
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | [**String**](string.md) | Unique identifier of the API schema object instance. The  ID is invariant and is assigned by the server. In other words  this entity will have the same ID throught its lifetime. | [optional] [default to null]
+**href** | [**URI**](URI.md) | URI reference of the API schema object instance. | [optional] [default to null]
+**name** | [**String**](string.md) | Name of the API schema object instance. | [optional] [default to null]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

doc/api/legato/serviceProvisioning/serviceCatalog/v4/openapi/Models/AttachmentRef.md

@@ -0,0 +1,17 @@
+# AttachmentRef
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Attype** | [**String**](string.md) | The concrete (non-abstract) class type of the API schema object. | [default to null]
+**AtbaseType** | [**String**](string.md) | When sub-classing, this defines the super/base class type (if  applicable) of the API schema object. | [optional] [default to null]
+**AtschemaLocation** | [**URI**](URI.md) | A URI refernce to the schema file that defines the attributes and relationships of the API schema object. | [optional] [default to null]
+**id** | [**String**](string.md) | Unique identifier of the API schema object instance. The  ID is invariant and is assigned by the server. In other words  this entity will have the same ID throught its lifetime. | [default to null]
+**href** | [**URI**](URI.md) | URI reference of the API schema object instance. | [optional] [default to null]
+**name** | [**String**](string.md) | Name of the API schema object instance. | [optional] [default to null]
+**AtreferredType** | [**String**](string.md) | The class type of the target API schema object instance. | [default to null]
+**description** | [**String**](string.md) | A narrative text describing the content of the attachment | [optional] [default to null]
+**url** | [**URI**](URI.md) | Link to the attachment media/content | [optional] [default to null]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

doc/api/legato/serviceProvisioning/serviceCatalog/v4/openapi/Models/AttachmentRefAllOf.md

@@ -0,0 +1,10 @@
+# AttachmentRefAllOf
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | [**String**](string.md) | A narrative text describing the content of the attachment | [optional] [default to null]
+**url** | [**URI**](URI.md) | Link to the attachment media/content | [optional] [default to null]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

doc/api/legato/serviceProvisioning/serviceCatalog/v4/openapi/Models/Error.md

@@ -0,0 +1,13 @@
+# Error
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | [**Integer**](integer.md) | Application related code. List of supported error codes are defined below:  **400: Bad Request** - 20: Invalid URL parameter value - 21: Missing body - 22: Invalid body - 23: Missing body field - 24: Invalid body field - 25: Missing header - 26: Invalid header value - 27: Missing query-string parameter - 28: Invalid query-string parameter value  **401: Unauthorized** - 40: Missing credentials - 41: Invalid credentials - 42: Expired credentials  **403: Forbidden** - 50: Access denied - 51: Forbidden requester - 52: Forbidden user - 53: Too many requests  **404: Not Found** - 60: Resource not found  **405: Method Not Allowed** - 61: Method not allowed  **408: Request Timeout** - 63: Request time-out  **409: Conflict** - 64: Resource Conflict  **422: Unprocessable Entity** - Functional Error codes specific to operation  **500: Internal Server Error** - 1: Internal Error  **501: Not Implemented**  **503: Service Unavailable** | [default to null]
+**reason** | [**String**](string.md) | Text that explains the reason for error. This can be shown to a client user. | [default to null]
+**message** | [**List**](string.md) | Text that provides more details and corrective actions related to the error. This can be shown to a client user. | [optional] [default to null]
+**status** | [**List**](string.md) | HTTP error code extension like 400-2. | [optional] [default to null]
+**referenceError** | [**List**](string.md) | URI pointing to (external) documentation describing the error. | [optional] [default to null]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

doc/api/legato/serviceProvisioning/serviceCatalog/v4/openapi/Models/EventSubscription.md

@@ -0,0 +1,11 @@
+# EventSubscription
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**query** | [**String**](string.md) | The query must have an eventType= information. Optionally a ? could be added to reduce hub. query”:”eventType = ServiceOrderStateChangeNotification”&serviceOrder.state=COMPLETED | [default to null]
+**callback** | [**String**](string.md) | URL where notification must be send | [default to null]
+**id** | [**String**](string.md) | Unique identifier of Hub | [default to null]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

doc/api/legato/serviceProvisioning/serviceCatalog/v4/openapi/Models/EventSubscriptionAllOf.md

@@ -0,0 +1,9 @@
+# EventSubscriptionAllOf
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | [**String**](string.md) | Unique identifier of Hub | [default to null]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

doc/api/legato/serviceProvisioning/serviceCatalog/v4/openapi/Models/EventSubscriptionInput.md

@@ -0,0 +1,10 @@
+# EventSubscriptionInput
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**query** | [**String**](string.md) | The query must have an eventType= information. Optionally a ? could be added to reduce hub. query”:”eventType = ServiceOrderStateChangeNotification”&serviceOrder.state=COMPLETED | [default to null]
+**callback** | [**String**](string.md) | URL where notification must be send | [default to null]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

doc/api/legato/serviceProvisioning/serviceCatalog/v4/openapi/Models/Extensible.md

@@ -0,0 +1,11 @@
+# Extensible
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Attype** | [**String**](string.md) | The concrete (non-abstract) class type of the API schema object. | [default to null]
+**AtbaseType** | [**String**](string.md) | When sub-classing, this defines the super/base class type (if  applicable) of the API schema object. | [optional] [default to null]
+**AtschemaLocation** | [**URI**](URI.md) | A URI refernce to the schema file that defines the attributes and relationships of the API schema object. | [optional] [default to null]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

doc/api/legato/serviceProvisioning/serviceCatalog/v4/openapi/Models/Referenceable.md

@@ -0,0 +1,15 @@
+# Referenceable
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Attype** | [**String**](string.md) | The concrete (non-abstract) class type of the API schema object. | [default to null]
+**AtbaseType** | [**String**](string.md) | When sub-classing, this defines the super/base class type (if  applicable) of the API schema object. | [optional] [default to null]
+**AtschemaLocation** | [**URI**](URI.md) | A URI refernce to the schema file that defines the attributes and relationships of the API schema object. | [optional] [default to null]
+**id** | [**String**](string.md) | Unique identifier of the API schema object instance. The  ID is invariant and is assigned by the server. In other words  this entity will have the same ID throught its lifetime. | [default to null]
+**href** | [**URI**](URI.md) | URI reference of the API schema object instance. | [optional] [default to null]
+**name** | [**String**](string.md) | Name of the API schema object instance. | [optional] [default to null]
+**AtreferredType** | [**String**](string.md) | The class type of the target API schema object instance. | [default to null]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

doc/api/legato/serviceProvisioning/serviceCatalog/v4/openapi/Models/ReferenceableAllOf.md

@@ -0,0 +1,9 @@
+# ReferenceableAllOf
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**AtreferredType** | [**String**](string.md) | The class type of the target API schema object instance. | [default to null]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+