Commit 1f5bf343 authored by M. Rehan Abbasi's avatar M. Rehan Abbasi
Browse files

add api-vis docs

parent a85f5212

docs/api-vis/.openapi-generator-ignore

0 → 100644
+23 −0
Original line number Diff line number Diff line 
# 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

docs/api-vis/.openapi-generator/FILES

0 → 100644
+58 −0
Original line number Diff line number Diff line 
.openapi-generator-ignore

Apis/UnsupportedApi.md

Apis/V2xiApi.md

Models/AppTerminationNotification.md

Models/AppTerminationNotificationLinks.md

Models/CellId.md

Models/Earfcn.md

Models/Ecgi.md

Models/FddInfo.md

Models/LinkType.md

Models/Links.md

Models/LocationInfo.md

Models/LocationInfoGeoArea.md

Models/MsgType.md

Models/OperationActionType.md

Models/Pc5NeighbourCellInfo.md

Models/Pc5ProvisioningInfo.md

Models/Pc5ProvisioningInfoProInfoPc5.md

Models/Plmn.md

Models/PredictedQos.md

Models/PredictedQosRoutes.md

Models/PredictedQosRoutesRouteInfo.md

Models/ProblemDetails.md

Models/ProvChgPc5Notification.md

Models/ProvChgPc5Subscription.md

Models/ProvChgPc5SubscriptionFilterCriteria.md

Models/ProvChgUuMbmsNotification.md

Models/ProvChgUuMbmsSubscription.md

Models/ProvChgUuMbmsSubscriptionFilterCriteria.md

Models/ProvChgUuUniNotification.md

Models/ProvChgUuUniSubscription.md

Models/ProvChgUuUniSubscriptionFilterCriteria.md

Models/SubscriptionLinkList.md

Models/SubscriptionLinkListLinks.md

Models/SubscriptionLinkListLinksSubscriptions.md

Models/TddInfo.md

Models/TestNotification.md

Models/TestNotificationLinks.md

Models/TimeStamp.md

Models/TransmissionBandwidth.md

Models/TransmissionBandwidthTransmissionBandwidth.md

Models/UuMbmsNeighbourCellInfo.md

Models/UuMbmsProvisioningInfo.md

Models/UuMbmsProvisioningInfoProInfoUuMbms.md

Models/UuUniNeighbourCellInfo.md

Models/UuUnicastProvisioningInfo.md

Models/UuUnicastProvisioningInfoProInfoUuUnicast.md

Models/V2xApplicationServer.md

Models/V2xMsgNotification.md

Models/V2xMsgNotificationLinks.md

Models/V2xMsgPublication.md

Models/V2xMsgSubscription.md

Models/V2xMsgSubscriptionFilterCriteria.md

Models/V2xServerUsd.md

Models/V2xServerUsdSdpInfo.md

Models/V2xServerUsdTmgi.md

Models/WebsockNotifConfig.md

README.md

docs/api-vis/.openapi-generator/VERSION

0 → 100644
+1 −0
Original line number Diff line number Diff line 
5.0.0-beta2
 
 No newline at end of file

docs/api-vis/Apis/UnsupportedApi.md

0 → 100644
+261 −0
Original line number Diff line number Diff line 
# UnsupportedApi



All URIs are relative to *https://localhost/sandboxname/vis/v2*



Method | HTTP request | Description

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

[**individualSubscriptionDELETE**](UnsupportedApi.md#individualSubscriptionDELETE) | **DELETE** /subscriptions/{subscriptionId} | Used to cancel the existing subscription.

[**individualSubscriptionGET**](UnsupportedApi.md#individualSubscriptionGET) | **GET** /subscriptions/{subscriptionId} | Retrieve information about this subscription.

[**individualSubscriptionPUT**](UnsupportedApi.md#individualSubscriptionPUT) | **PUT** /subscriptions/{subscriptionId} | Used to update the existing subscription.

[**provInfoGET**](UnsupportedApi.md#provInfoGET) | **GET** /queries/pc5_provisioning_info | Query provisioning information for V2X communication over PC5.

[**provInfoUuMbmsGET**](UnsupportedApi.md#provInfoUuMbmsGET) | **GET** /queries/uu_mbms_provisioning_info | retrieve information required for V2X communication over Uu MBMS.

[**provInfoUuUnicastGET**](UnsupportedApi.md#provInfoUuUnicastGET) | **GET** /queries/uu_unicast_provisioning_info | Used to query provisioning information for V2X communication over Uu unicast.

[**subGET**](UnsupportedApi.md#subGET) | **GET** /subscriptions | Request information about the subscriptions for this requestor.

[**subPOST**](UnsupportedApi.md#subPOST) | **POST** /subscriptions |  create a new subscription to VIS notifications.

[**v2xMessagePOST**](UnsupportedApi.md#v2xMessagePOST) | **POST** /publish_v2x_message | Used to publish a V2X message.





<a name="individualSubscriptionDELETE"></a>

# **individualSubscriptionDELETE**

> individualSubscriptionDELETE(subscriptionId)



Used to cancel the existing subscription.



    Used to cancel the existing subscription.



### Parameters



Name | Type | Description  | Notes

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

 **subscriptionId** | **String**| Refers to created subscription, where the VIS API allocates a unique resource name for this subscription | [default to null]



### Return type



null (empty response body)



### Authorization



No authorization required



### HTTP request headers



- **Content-Type**: Not defined

- **Accept**: application/json



<a name="individualSubscriptionGET"></a>

# **individualSubscriptionGET**

> oneOf&lt;ProvChgUuUniSubscription,ProvChgUuMbmsSubscription,ProvChgPc5Subscription,V2xMsgSubscription&gt; individualSubscriptionGET(subscriptionId)



Retrieve information about this subscription.



    Retrieve information about this subscription.



### Parameters



Name | Type | Description  | Notes

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

 **subscriptionId** | **String**| Refers to created subscription, where the VIS API allocates a unique resource name for this subscription | [default to null]



### Return type



[**oneOf&lt;ProvChgUuUniSubscription,ProvChgUuMbmsSubscription,ProvChgPc5Subscription,V2xMsgSubscription&gt;**](../Models/oneOf&lt;ProvChgUuUniSubscription,ProvChgUuMbmsSubscription,ProvChgPc5Subscription,V2xMsgSubscription&gt;.md)



### Authorization



No authorization required



### HTTP request headers



- **Content-Type**: Not defined

- **Accept**: application/json



<a name="individualSubscriptionPUT"></a>

# **individualSubscriptionPUT**

> oneOf&lt;ProvChgUuUniSubscription,ProvChgUuMbmsSubscription,ProvChgPc5Subscription,V2xMsgSubscription&gt; individualSubscriptionPUT(subscriptionId, UNKNOWN\_BASE\_TYPE)



Used to update the existing subscription.



    Used to update the existing subscription.



### Parameters



Name | Type | Description  | Notes

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

 **subscriptionId** | **String**| Refers to created subscription, where the VIS API allocates a unique resource name for this subscription | [default to null]

 **UNKNOWN\_BASE\_TYPE** | [**UNKNOWN_BASE_TYPE**](../Models/UNKNOWN_BASE_TYPE.md)|  |



### Return type



[**oneOf&lt;ProvChgUuUniSubscription,ProvChgUuMbmsSubscription,ProvChgPc5Subscription,V2xMsgSubscription&gt;**](../Models/oneOf&lt;ProvChgUuUniSubscription,ProvChgUuMbmsSubscription,ProvChgPc5Subscription,V2xMsgSubscription&gt;.md)



### Authorization



No authorization required



### HTTP request headers



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

- **Accept**: application/json



<a name="provInfoGET"></a>

# **provInfoGET**

> Pc5ProvisioningInfo provInfoGET(location\_info)



Query provisioning information for V2X communication over PC5.



    Query provisioning information for V2X communication over PC5.



### Parameters



Name | Type | Description  | Notes

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

 **location\_info** | **String**| Comma separated list of locations to identify a cell of a base station or a particular geographical area | [default to null]



### Return type



[**Pc5ProvisioningInfo**](../Models/Pc5ProvisioningInfo.md)



### Authorization



No authorization required



### HTTP request headers



- **Content-Type**: Not defined

- **Accept**: application/json



<a name="provInfoUuMbmsGET"></a>

# **provInfoUuMbmsGET**

> UuMbmsProvisioningInfo provInfoUuMbmsGET(location\_info)



retrieve information required for V2X communication over Uu MBMS.



    retrieve information required for V2X communication over Uu MBMS.



### Parameters



Name | Type | Description  | Notes

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

 **location\_info** | **String**| omma separated list of locations to identify a cell of a base station or a particular geographical area | [default to null]



### Return type



[**UuMbmsProvisioningInfo**](../Models/UuMbmsProvisioningInfo.md)



### Authorization



No authorization required



### HTTP request headers



- **Content-Type**: Not defined

- **Accept**: application/json



<a name="provInfoUuUnicastGET"></a>

# **provInfoUuUnicastGET**

> UuUnicastProvisioningInfo provInfoUuUnicastGET(location\_info)



Used to query provisioning information for V2X communication over Uu unicast.



    Used to query provisioning information for V2X communication over Uu unicast.



### Parameters



Name | Type | Description  | Notes

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

 **location\_info** | **String**| Comma separated list of locations to identify a cell of a base station or a particular geographical area | [default to null]



### Return type



[**UuUnicastProvisioningInfo**](../Models/UuUnicastProvisioningInfo.md)



### Authorization



No authorization required



### HTTP request headers



- **Content-Type**: Not defined

- **Accept**: application/json



<a name="subGET"></a>

# **subGET**

> SubscriptionLinkList subGET(subscription\_type)



Request information about the subscriptions for this requestor.



    Request information about the subscriptions for this requestor.



### Parameters



Name | Type | Description  | Notes

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

 **subscription\_type** | **String**| Query parameter to filter on a specific subscription type. Permitted values:  prov_chg_uu_uni: provisioning information change for V2X communication over Uuunicast prov_chg_uu_mbms: provisioning information change for V2X communication over Uu MBMS prov_chg_uu_pc5: provisioning information change for V2X communication over PC5. v2x_msg: V2X interoperability message | [optional] [default to null]



### Return type



[**SubscriptionLinkList**](../Models/SubscriptionLinkList.md)



### Authorization



No authorization required



### HTTP request headers



- **Content-Type**: Not defined

- **Accept**: application/json



<a name="subPOST"></a>

# **subPOST**

> oneOf&lt;ProvChgUuUniSubscription,ProvChgUuMbmsSubscription,ProvChgPc5Subscription,V2xMsgSubscription&gt; subPOST(UNKNOWN\_BASE\_TYPE)



 create a new subscription to VIS notifications.



     create a new subscription to VIS notifications.



### Parameters



Name | Type | Description  | Notes

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

 **UNKNOWN\_BASE\_TYPE** | [**UNKNOWN_BASE_TYPE**](../Models/UNKNOWN_BASE_TYPE.md)|  |



### Return type



[**oneOf&lt;ProvChgUuUniSubscription,ProvChgUuMbmsSubscription,ProvChgPc5Subscription,V2xMsgSubscription&gt;**](../Models/oneOf&lt;ProvChgUuUniSubscription,ProvChgUuMbmsSubscription,ProvChgPc5Subscription,V2xMsgSubscription&gt;.md)



### Authorization



No authorization required



### HTTP request headers



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

- **Accept**: application/json



<a name="v2xMessagePOST"></a>

# **v2xMessagePOST**

> v2xMessagePOST(V2xMsgPublication)



Used to publish a V2X message.



    Used to publish a V2X message.



### Parameters



Name | Type | Description  | Notes

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

 **V2xMsgPublication** | [**V2xMsgPublication**](../Models/V2xMsgPublication.md)|  |



### Return type



null (empty response body)



### Authorization



No authorization required



### HTTP request headers



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

- **Accept**: application/json

docs/api-vis/Apis/V2xiApi.md

0 → 100644
+64 −0
Original line number Diff line number Diff line 
# V2xiApi



All URIs are relative to *https://localhost/sandboxname/vis/v2*



Method | HTTP request | Description

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

[**mec011AppTerminationPOST**](V2xiApi.md#mec011AppTerminationPOST) | **POST** /notifications/mec011/appTermination | MEC011 Application Termination notification for self termination

[**predictedQosPOST**](V2xiApi.md#predictedQosPOST) | **POST** /provide_predicted_qos | Request the predicted QoS correspondent to potential routes of a vehicular UE.





<a name="mec011AppTerminationPOST"></a>

# **mec011AppTerminationPOST**

> mec011AppTerminationPOST(AppTerminationNotification)



MEC011 Application Termination notification for self termination



    Terminates itself.



### Parameters



Name | Type | Description  | Notes

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

 **AppTerminationNotification** | [**AppTerminationNotification**](../Models/AppTerminationNotification.md)| Termination notification details |



### Return type



null (empty response body)



### Authorization



No authorization required



### HTTP request headers



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

- **Accept**: Not defined



<a name="predictedQosPOST"></a>

# **predictedQosPOST**

> PredictedQos predictedQosPOST(PredictedQos)



Request the predicted QoS correspondent to potential routes of a vehicular UE.



    Request the predicted QoS correspondent to potential routes of a vehicular UE.



### Parameters



Name | Type | Description  | Notes

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

 **PredictedQos** | [**PredictedQos**](../Models/PredictedQos.md)|  |



### Return type



[**PredictedQos**](../Models/PredictedQos.md)



### Authorization



No authorization required



### HTTP request headers



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

- **Accept**: application/json