Commit 84f9295f authored by Yann Garcia's avatar Yann Garcia
Browse files

Update meep-vis documentation

parent c4a484d5
Loading
Loading
Loading
Loading
+26 −28
Original line number Diff line number Diff line
# {{classname}}
# V2xiApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**V2xMessagePOST**](V2XMsgApi.md#V2xMessagePOST) | **Post** /publish_v2x_message | Used to publish a V2X message.
[**V2xMsgDistributionServerPost**](V2XMsgApi.md#V2xMsgDistributionServerPost) | **Post** /provide_v2x_msg_distribution_server_info | Request the information about available V2X Message Distribution Servers that can be supported by the service consumer.
[**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.

# **V2xMessagePOST**
> V2xMessagePOST(ctx, body)
Used to publish a V2X message.

Used to publish a V2X message.
<a name="mec011AppTerminationPOST"></a>
# **mec011AppTerminationPOST**
> mec011AppTerminationPOST(AppTerminationNotification)

### Required Parameters
MEC011 Application Termination notification for self termination

    Terminates itself.

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
  **body** | [**V2xMsgPublication**](V2xMsgPublication.md)|  | 
 **AppTerminationNotification** | [**AppTerminationNotification**](../Models/AppTerminationNotification.md)| Termination notification details |

### Return type

 (empty response body)
null (empty response body)

### Authorization

@@ -31,26 +33,25 @@ No authorization required
### HTTP request headers

- **Content-Type**: application/json
 - **Accept**: application/json
- **Accept**: Not defined

[[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)
<a name="predictedQosPOST"></a>
# **predictedQosPOST**
> PredictedQos predictedQosPOST(PredictedQos)

# **V2xMsgDistributionServerPost**
> V2xMsgDistributionServerInfo V2xMsgDistributionServerPost(ctx, body)
Request the information about available V2X Message Distribution Servers that can be supported by the service consumer.
Request the predicted QoS correspondent to potential routes of a vehicular UE.

Request the information about available V2X Message Distribution Servers that can be supported by the service consumer (e.g. a MEC application).
    Request the predicted QoS correspondent to potential routes of a vehicular UE.

### Required Parameters
### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
  **body** | [**V2xMsgDistributionServerInfo**](V2xMsgDistributionServerInfo.md)|  | 
 **PredictedQos** | [**PredictedQos**](../Models/PredictedQos.md)|  |

### Return type

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

### Authorization

@@ -60,6 +61,3 @@ No authorization required

- **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)
+65 −0
Original line number Diff line number Diff line
# {{classname}}

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**V2xMessagePOST**](V2XMsgApi.md#V2xMessagePOST) | **Post** /publish_v2x_message | Used to publish a V2X message.
[**V2xMsgDistributionServerPost**](V2XMsgApi.md#V2xMsgDistributionServerPost) | **Post** /provide_v2x_msg_distribution_server_info | Request the information about available V2X Message Distribution Servers that can be supported by the service consumer.

# **V2xMessagePOST**
> V2xMessagePOST(ctx, body)
Used to publish a V2X message.

Used to publish a V2X message.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
  **body** | [**V2xMsgPublication**](V2xMsgPublication.md)|  | 

### Return type

 (empty response body)

### 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)

# **V2xMsgDistributionServerPost**
> V2xMsgDistributionServerInfo V2xMsgDistributionServerPost(ctx, body)
Request the information about available V2X Message Distribution Servers that can be supported by the service consumer.

Request the information about available V2X Message Distribution Servers that can be supported by the service consumer (e.g. a MEC application).

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
  **body** | [**V2xMsgDistributionServerInfo**](V2xMsgDistributionServerInfo.md)|  | 

### Return type

[**V2xMsgDistributionServerInfo**](V2xMsgDistributionServerInfo.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)