Commit 678777e7 authored by muhammadh's avatar muhammadh
Browse files

update docs and README file in meep-service-mgmt-client as per MEC011 v2.2.1

parent 3c576488
Loading
Loading
Loading
Loading
+4 −0
Original line number Diff line number Diff line
@@ -57,7 +57,11 @@ Class | Method | HTTP request | Description
 - [ServiceAvailabilityNotification](docs/ServiceAvailabilityNotification.md)
 - [ServiceAvailabilityNotificationServiceReferences](docs/ServiceAvailabilityNotificationServiceReferences.md)
 - [ServiceInfo](docs/ServiceInfo.md)
 - [ServiceInfoLinks](docs/ServiceInfoLinks.md)
 - [ServiceInfoPost](docs/ServiceInfoPost.md)
 - [ServiceLivenessInfo](docs/ServiceLivenessInfo.md)
 - [ServiceLivenessInfoTimeStamp](docs/ServiceLivenessInfoTimeStamp.md)
 - [ServiceLivenessUpdate](docs/ServiceLivenessUpdate.md)
 - [ServiceState](docs/ServiceState.md)
 - [Subscription](docs/Subscription.md)
 - [SubscriptionLinkList](docs/SubscriptionLinkList.md)
+0 −1
Original line number Diff line number Diff line
@@ -7,4 +7,3 @@ Name | Type | Description | Notes

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+5 −7
Original line number Diff line number Diff line
# \MecServiceMgmtApi
# {{classname}}

All URIs are relative to *https://localhost/sandboxname/mec_service_mgmt/v1*

@@ -30,11 +30,10 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
  **appInstanceId** | **string**| Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager. | 
 **optional** | ***AppServicesGETOpts** | optional parameters | nil if no parameters
 **optional** | ***MecServiceMgmtApiAppServicesGETOpts** | optional parameters | nil if no parameters

### Optional Parameters
Optional parameters are passed through a pointer to a AppServicesGETOpts struct

Optional parameters are passed through a pointer to a MecServiceMgmtApiAppServicesGETOpts struct
Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------

@@ -303,11 +302,10 @@ This method retrieves information about a list of mecService resources. This met
Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
 **optional** | ***ServicesGETOpts** | optional parameters | nil if no parameters
 **optional** | ***MecServiceMgmtApiServicesGETOpts** | optional parameters | nil if no parameters

### Optional Parameters
Optional parameters are passed through a pointer to a ServicesGETOpts struct

Optional parameters are passed through a pointer to a MecServiceMgmtApiServicesGETOpts struct
Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **serInstanceId** | [**optional.Interface of []string**](string.md)| A MEC application instance may use multiple ser_instance_ids as an input parameter to query the availability of a list of MEC service instances. Either \"ser_instance_id\" or \"ser_name\" or \"ser_category_id\" or none of them shall be present. | 
+2 −0
Original line number Diff line number Diff line
@@ -13,6 +13,8 @@ Name | Type | Description | Notes
**ScopeOfLocality** | [***LocalityType**](LocalityType.md) |  | [optional] [default to null]
**ConsumedLocalOnly** | **bool** | Indicate whether the service can only be consumed by the MEC applications located in the same locality (as defined by scopeOfLocality) as this  service instance. | [optional] [default to null]
**IsLocal** | **bool** | Indicate whether the service is located in the same locality (as defined by scopeOfLocality) as the consuming MEC application. | [optional] [default to null]
**LivenessInterval** | **int32** | Interval (in seconds) between two consecutive \"heartbeat\" messages (see clause 8.2.10.3.3). If the service-producing application supports sending \"heartbeat\" messages, it shall include this attribute in the registration request. In this case, the application shall either set the value of this attribute to zero or shall use this attribute to propose a non-zero positive value for the liveness interval. If the application has provided this attribute in the request and the MEC platform requires \"heartbeat\" messages, the MEC platform shall return this attribute value in the HTTP responses. The MEC platform may use the value proposed in the request or may choose a different value. If the MEC platform does not require \"heartbeat\" messages for this service instance it shall omit the attribute in responses. | [optional] [default to null]
**Links** | [***ServiceInfoLinks**](ServiceInfo__links.md) |  | [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)

+10 −0
Original line number Diff line number Diff line
# ServiceInfoLinks

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Self** | [***LinkType**](LinkType.md) |  | [default to null]
**Liveness** | [***LinkType**](LinkType.md) |  | [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)
Loading