Commit 5fbeef38 authored by Simon Pastor's avatar Simon Pastor
Browse files

{apiRoot} removal

parent d34088d0

go-packages/meep-rnis-client/docs/DefaultApi.md

deleted100644 → 0
+0 −353
Original line number Diff line number Diff line 
# \DefaultApi



All URIs are relative to *https://{apiRoot}/rni/v2*



Method | HTTP request | Description

------------- | ------------- | -------------

[**Layer2MeasInfoGET**](DefaultApi.md#Layer2MeasInfoGET) | **Get** /queries/layer2_meas | Retrieve information on layer 2 measurements

[**PlmnInfoGET**](DefaultApi.md#PlmnInfoGET) | **Get** /queries/plmn_info | Retrieve information on the underlying Mobile Network that the MEC application is associated to

[**RabInfoGET**](DefaultApi.md#RabInfoGET) | **Get** /queries/rab_info | Retrieve information on Radio Access Bearers

[**S1BearerInfoGET**](DefaultApi.md#S1BearerInfoGET) | **Get** /queries/s1_bearer_info | Retrieve S1-U bearer information related to specific UE(s)

[**SubscriptionLinkListSubscriptionsGET**](DefaultApi.md#SubscriptionLinkListSubscriptionsGET) | **Get** /subscriptions/ | Retrieve information on subscriptions for notifications

[**SubscriptionsDELETE**](DefaultApi.md#SubscriptionsDELETE) | **Delete** /subscriptions/{subscriptionId} | Cancel an existing subscription

[**SubscriptionsGET**](DefaultApi.md#SubscriptionsGET) | **Get** /subscriptions/{subscriptionId} | Retrieve information on current specific subscription

[**SubscriptionsPOST**](DefaultApi.md#SubscriptionsPOST) | **Post** /subscriptions/ | Create a new subscription

[**SubscriptionsPUT**](DefaultApi.md#SubscriptionsPUT) | **Put** /subscriptions/{subscriptionId} | Modify an existing subscription





# **Layer2MeasInfoGET**

> InlineResponse2003 Layer2MeasInfoGET(ctx, optional)

Retrieve information on layer 2 measurements



Queries information about the layer 2 measurements.



### Required Parameters



Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.

 **optional** | ***Layer2MeasInfoGETOpts** | optional parameters | nil if no parameters



### Optional Parameters

Optional parameters are passed through a pointer to a Layer2MeasInfoGETOpts struct



Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **appInsId** | **optional.String**| Application instance identifier | 

 **cellId** | [**optional.Interface of []string**](string.md)| Comma separated list of E-UTRAN Cell Identities | 

 **ueIpv4Address** | [**optional.Interface of []string**](string.md)| Comma separated list of IE IPv4 addresses as defined for the type for AssociateId | 

 **ueIpv6Address** | [**optional.Interface of []string**](string.md)| Comma separated list of IE IPv6 addresses as defined for the type for AssociateId | 

 **natedIpAddress** | [**optional.Interface of []string**](string.md)| Comma separated list of IE NATed IP addresses as defined for the type for AssociateId | 

 **gtpTeid** | [**optional.Interface of []string**](string.md)| Comma separated list of GTP TEID addresses as defined for the type for AssociateId | 

 **dlGbrPrbUsageCell** | **optional.Int32**| PRB usage for downlink GBR traffic in percentage as defined in ETSI TS 136 314 | 

 **ulGbrPrbUsageCell** | **optional.Int32**| PRB usage for uplink GBR traffic in percentage as defined in ETSI TS 136 314 | 

 **dlNongbrPrbUsageCell** | **optional.Int32**| PRB usage for downlink non-GBR traffic in percentage as defined in ETSI TS 136 314 | 

 **ulNongbrPrbUsageCell** | **optional.Int32**| PRB usage for uplink non-GBR traffic in percentage as defined in ETSI TS 136 314 | 

 **dlTotalPrbUsageCell** | **optional.Int32**| PRB usage for total downlink traffic in percentage as defined in ETSI TS 136 314 | 

 **ulTotalPrbUsageCell** | **optional.Int32**| PRB usage for total uplink traffic in percentage as defined in ETSI TS 136 314 | 

 **receivedDedicatedPreamblesCell** | **optional.Int32**| Received dedicated preambles in percentage as defined in ETSI TS 136 314 | 

 **receivedRandomlySelectedPreamblesLowRangeCell** | **optional.Int32**| Received randomly selected preambles in the low range in percentage as defined in ETSI TS 136 314 | 

 **receivedRandomlySelectedPreamblesHighRangeCell** | **optional.Int32**| Received rendomly selected preambles in the high range in percentage as defined in ETSI TS 136 314 | 

 **numberOfActiveUeDlGbrCell** | **optional.Int32**| Number of active UEs with downlink GBR traffic as defined in ETSI TS 136 314 | 

 **numberOfActiveUeUlGbrCell** | **optional.Int32**| Number of active UEs with uplink GBR traffic as defined in ETSI TS 136 314 | 

 **numberOfActiveUeDlNongbrCell** | **optional.Int32**| Number of active UEs with downlink non-GBR traffic as defined in ETSI TS 136 314 | 

 **numberOfActiveUeUlNongbrCell** | **optional.Int32**| Number of active UEs with uplink non-GBR traffic as defined in ETSI TS 136 314 | 

 **dlGbrPdrCell** | **optional.Int32**| Packet discard rate for downlink GBR traffic in percentage as defined in ETSI TS 136 314 | 

 **ulGbrPdrCell** | **optional.Int32**| Packet discard rate for uplink GBR traffic in percentage as defined in ETSI TS 136 314 | 

 **dlNongbrPdrCell** | **optional.Int32**| Packet discard rate for downlink non-GBR traffic in percentage as defined in ETSI TS 136 314 | 

 **ulNongbrPdrCell** | **optional.Int32**| Packet discard rate for uplink non-GBR traffic in percentage as defined in ETSI TS 136 314 | 

 **dlGbrDelayUe** | **optional.Int32**| Packet delay of downlink GBR traffic of a UE as defined in ETSI TS 136 314 | 

 **ulGbrDelayUe** | **optional.Int32**| Packet delay of uplink GBR traffic of a UE as defined in ETSI TS 136 314 | 

 **dlNongbrDelayUe** | **optional.Int32**| Packet delay of downlink non-GBR traffic of a UE as defined in ETSI TS 136 314 | 

 **ulNongbrDelayUe** | **optional.Int32**| Packet delay of uplink non-GBR traffic of a UE as defined in ETSI TS 136 314 | 

 **dlGbrPdrUe** | **optional.Int32**| Packet discard rate of downlink GBR traffic of a UE in percentage as defined in ETSI TS 136 314 | 

 **ulGbrPdrUe** | **optional.Int32**| Packet discard rate of uplink GBR traffic of a UE in percentage as defined in ETSI TS 136 314 | 

 **dlNongbrPdrUe** | **optional.Int32**| Packet discard rate of downlink non-GBR traffic of a UE in percentage as defined in ETSI TS 136 314 | 

 **ulNongbrPdrUe** | **optional.Int32**| Packet discard rate of uplink non-GBR traffic of a UE in percentage as defined in ETSI TS 136 314 | 

 **dlGbrThroughputUe** | **optional.Int32**| Scheduled throughput of downlink GBR traffic of a UE as defined in ETSI TS 136 314 | 

 **ulGbrThroughputUe** | **optional.Int32**| Scheduled throughput of uplink GBR traffic of a UE as defined in ETSI TS 136 314 | 

 **dlNongbrThroughputUe** | **optional.Int32**| Scheduled throughput of downlink non-GBR traffic of a UE as defined in ETSI TS 136 314 | 

 **ulNongbrThroughputUe** | **optional.Int32**| Scheduled throughput of uplink non-GBR traffic of a UE as defined in ETSI TS 136 314 | 

 **dlGbrDataVolumeUe** | **optional.Int32**| Data volume of downlink GBR traffic of a UE as defined in ETSI TS 136 314 | 

 **ulGbrDataVolumeUe** | **optional.Int32**| Data volume of uplink GBR traffic of a UE as defined in ETSI TS 136 314 | 

 **dlNongbrDataVolumeUe** | **optional.Int32**| Data volume of downlink non-GBR traffic of a UE as defined in ETSI TS 136 314 | 

 **ulNongbrDataVolumeUe** | **optional.Int32**| Data volume of uplink non-GBR traffic of a UE as defined in ETSI TS 136 314 | 



### Return type



[**InlineResponse2003**](inline_response_200_3.md)



### Authorization



No authorization required



### HTTP request headers



 - **Content-Type**: Not defined

 - **Accept**: application/json



[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)



# **PlmnInfoGET**

> InlineResponse2001 PlmnInfoGET(ctx, appInsId)

Retrieve information on the underlying Mobile Network that the MEC application is associated to



Queries information about the Mobile Network



### Required Parameters



Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.

  **appInsId** | [**[]string**](string.md)| Comma separated list of Application instance identifiers | 



### Return type



[**InlineResponse2001**](inline_response_200_1.md)



### Authorization



No authorization required



### HTTP request headers



 - **Content-Type**: Not defined

 - **Accept**: application/json



[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)



# **RabInfoGET**

> InlineResponse200 RabInfoGET(ctx, optional)

Retrieve information on Radio Access Bearers



Queries information about the Radio Access Bearers



### Required Parameters



Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.

 **optional** | ***RabInfoGETOpts** | optional parameters | nil if no parameters



### Optional Parameters

Optional parameters are passed through a pointer to a RabInfoGETOpts struct



Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **appInsId** | **optional.String**| Application instance identifier | 

 **cellId** | [**optional.Interface of []string**](string.md)| Comma separated list of E-UTRAN Cell Identities | 

 **ueIpv4Address** | [**optional.Interface of []string**](string.md)| Comma separated list of IE IPv4 addresses as defined for the type for AssociateId | 

 **ueIpv6Address** | [**optional.Interface of []string**](string.md)| Comma separated list of IE IPv6 addresses as defined for the type for AssociateId | 

 **natedIpAddress** | [**optional.Interface of []string**](string.md)| Comma separated list of IE NATed IP addresses as defined for the type for AssociateId | 

 **gtpTeid** | [**optional.Interface of []string**](string.md)| Comma separated list of GTP TEID addresses as defined for the type for AssociateId | 

 **erabId** | **optional.Int32**| E-RAB identifier | 

 **qci** | **optional.Int32**| QoS Class Identifier as defined in ETSI TS 123 401 | 

 **erabMbrDl** | **optional.Int32**| Maximum downlink E-RAB Bit Rate as defined in ETSI TS 123 401 | 

 **erabMbrUl** | **optional.Int32**| Maximum uplink E-RAB Bit Rate as defined in ETSI TS 123 401 | 

 **erabGbrDl** | **optional.Int32**| Guaranteed downlink E-RAB Bit Rate as defined in ETSI TS 123 401 | 

 **erabGbrUl** | **optional.Int32**| Guaranteed uplink E-RAB Bit Rate as defined in ETSI TS 123 401 | 



### Return type



[**InlineResponse200**](inline_response_200.md)



### Authorization



No authorization required



### HTTP request headers



 - **Content-Type**: Not defined

 - **Accept**: application/json



[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)



# **S1BearerInfoGET**

> InlineResponse2002 S1BearerInfoGET(ctx, optional)

Retrieve S1-U bearer information related to specific UE(s)



Queries information about the S1 bearer(s)



### Required Parameters



Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.

 **optional** | ***S1BearerInfoGETOpts** | optional parameters | nil if no parameters



### Optional Parameters

Optional parameters are passed through a pointer to a S1BearerInfoGETOpts struct



Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **tempUeId** | [**optional.Interface of []string**](string.md)| Comma separated list of temporary identifiers allocated for the specific UE as defined in   ETSI TS 136 413 | 

 **ueIpv4Address** | [**optional.Interface of []string**](string.md)| Comma separated list of IE IPv4 addresses as defined for the type for AssociateId | 

 **ueIpv6Address** | [**optional.Interface of []string**](string.md)| Comma separated list of IE IPv6 addresses as defined for the type for AssociateId | 

 **natedIpAddress** | [**optional.Interface of []string**](string.md)| Comma separated list of IE NATed IP addresses as defined for the type for AssociateId | 

 **gtpTeid** | [**optional.Interface of []string**](string.md)| Comma separated list of GTP TEID addresses as defined for the type for AssociateId | 

 **cellId** | [**optional.Interface of []string**](string.md)| Comma separated list of E-UTRAN Cell Identities | 

 **erabId** | [**optional.Interface of []int32**](int32.md)| Comma separated list of E-RAB identifiers | 



### Return type



[**InlineResponse2002**](inline_response_200_2.md)



### Authorization



No authorization required



### HTTP request headers



 - **Content-Type**: Not defined

 - **Accept**: application/json



[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)



# **SubscriptionLinkListSubscriptionsGET**

> InlineResponse2004 SubscriptionLinkListSubscriptionsGET(ctx, optional)

Retrieve information on subscriptions for notifications



Queries information on subscriptions for notifications



### Required Parameters



Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.

 **optional** | ***SubscriptionLinkListSubscriptionsGETOpts** | optional parameters | nil if no parameters



### Optional Parameters

Optional parameters are passed through a pointer to a SubscriptionLinkListSubscriptionsGETOpts struct



Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **subscriptionType** | **optional.String**| Subscription type filter | 



### Return type



[**InlineResponse2004**](inline_response_200_4.md)



### Authorization



No authorization required



### HTTP request headers



 - **Content-Type**: Not defined

 - **Accept**: application/json



[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)



# **SubscriptionsDELETE**

> SubscriptionsDELETE(ctx, subscriptionId)

Cancel an existing subscription



Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)



### Required Parameters



Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.

  **subscriptionId** | **string**| Subscription Id, specifically the \"Self-referring URI\" returned in the subscription request | 



### Return type



 (empty response body)



### Authorization



No authorization required



### HTTP request headers



 - **Content-Type**: Not defined

 - **Accept**: application/json



[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)



# **SubscriptionsGET**

> InlineResponse2005 SubscriptionsGET(ctx, subscriptionId)

Retrieve information on current specific subscription



Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)



### Required Parameters



Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.

  **subscriptionId** | **string**| Subscription Id, specifically the \"Self-referring URI\" returned in the subscription request | 



### Return type



[**InlineResponse2005**](inline_response_200_5.md)



### Authorization



No authorization required



### HTTP request headers



 - **Content-Type**: Not defined

 - **Accept**: application/json



[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)



# **SubscriptionsPOST**

> InlineResponse201 SubscriptionsPOST(ctx, body)

Create a new subscription



Creates a new subscription to Radio Network Information notifications



### Required Parameters



Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.

  **body** | [**Body**](Body.md)| Subscription to be created | 



### Return type



[**InlineResponse201**](inline_response_201.md)



### Authorization



No authorization required



### HTTP request headers



 - **Content-Type**: application/json

 - **Accept**: application/json



[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)



# **SubscriptionsPUT**

> InlineResponse2006 SubscriptionsPUT(ctx, body, subscriptionId)

Modify an existing subscription



Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)



### Required Parameters



Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.

  **body** | [**Body1**](Body1.md)| Subscription to be modified | 

  **subscriptionId** | **string**| Subscription Id, specifically the \"Self-referring URI\" returned in the subscription request | 



### Return type



[**InlineResponse2006**](inline_response_200_6.md)



### Authorization



No authorization required



### HTTP request headers



 - **Content-Type**: application/json

 - **Accept**: application/json



[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

go-packages/meep-rnis-notification-client/api/swagger.yaml

+3 −1
Original line number Diff line number Diff line
@@ -20,7 +20,9 @@ externalDocs: 
  description: ETSI GS MEC 012 Radio Network Information API, V2.1.1

  url: http://www.etsi.org/deliver/etsi_gs/MEC/001_099/012/02.01.01_60/gs_mec012v020101p.pdf

servers:

- url: https://{apiRoot}/rni/v2

- url: https://localhost/rni/v2

tags:

- name: notifications

paths:

  /notifications/ca_reconf/{subscriptionId}:

    post:

go-packages/meep-rnis-notification-client/docs/DefaultApi.md

deleted100644 → 0
+0 −308

File deleted.

Preview size limit exceeded, changes collapsed.