Commit cc26b21d authored by ETSI CTI's avatar ETSI CTI

Merge branch 'develop' into 'master'

STF593 - Milestone A - Merge v2.1.1 to Master branch

See merge request !3
parents ca92c950 93b1f7ca
Pipeline #5861 passed with stage
in 0 seconds
......@@ -4,12 +4,15 @@ specfiles=$(ls | egrep "^[^.]*.(json|yaml)")
fres=0
for i in $specfiles ; do
echo "-- Validating OpenAPI file $i..."
swagger-tools validate $i
echo "-- Validating and linting OpenAPI file $i..."
swagger-cli validate $i
res=$?
fres=$(($fres||$res))
echo -e "-- Validator returned $res.\n"
speccy lint "$i"
res2=$?
fres=$(($fres||$res||$res2))
echo "--- Validator returned $res, linter returned $res2."
done
echo "-- Final validator returns $fres."
exit $fres
......@@ -4,9 +4,8 @@ This repository contains OpenAPIs descriptions for the interfaces specified in E
## Online resources
* [Specification document](https://www.etsi.org/deliver/etsi_gs/MEC/001_099/012/01.01.01_60/gs_MEC012v010101p.pdf)
* [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs012-rnis-api/raw/master/RniAPI.yaml).
* [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs012-rnis-api/raw/master/RniAPI.yaml).
* [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs012-rnis-api/raw/stf593/RniAPI.yaml).
* [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs012-rnis-api/raw/stf593/RniAPI.yaml).
## License
......
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
# 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
.openapi-generator-ignore
README.md
models/associate_id.proto
models/ca_reconf_notification.proto
models/ca_reconf_notification_carrier_aggregation_meas_info.proto
models/ca_reconf_notification_secondary_cell_add.proto
models/ca_reconf_subscription.proto
models/ca_reconf_subscription_filter_criteria_assoc.proto
models/ca_reconf_subscription_links.proto
models/cell_change_notification.proto
models/cell_change_notification_temp_ue_id.proto
models/cell_change_subscription.proto
models/cell_change_subscription_filter_criteria_assoc_ho.proto
models/ecgi.proto
models/expiry_notification.proto
models/expiry_notification_links.proto
models/inline_notification.proto
models/inline_subscription.proto
models/l2_meas.proto
models/l2_meas_cell_info.proto
models/l2_meas_cell_ue_info.proto
models/link_type.proto
models/meas_quantity_results_nr.proto
models/meas_rep_ue_notification.proto
models/meas_rep_ue_notification_carrier_aggregation_meas_info.proto
models/meas_rep_ue_notification_eutran_neighbour_cell_meas_info.proto
models/meas_rep_ue_notification_new_radio_meas_info.proto
models/meas_rep_ue_notification_new_radio_meas_nei_info.proto
models/meas_rep_ue_notification_nr_bn_cs.proto
models/meas_rep_ue_notification_nr_bn_cs_nr_bn_cell_info.proto
models/meas_rep_ue_notification_nr_n_cell_info.proto
models/meas_rep_ue_notification_nr_s_cs.proto
models/meas_rep_ue_notification_nr_s_cs_nr_s_cell_info.proto
models/meas_rep_ue_subscription.proto
models/meas_rep_ue_subscription_filter_criteria_assoc_tri.proto
models/meas_ta_notification.proto
models/meas_ta_subscription.proto
models/n_rcgi.proto
models/nr_meas_rep_ue_notification.proto
models/nr_meas_rep_ue_notification_eutra_neigh_cell_meas_info.proto
models/nr_meas_rep_ue_notification_n_cell.proto
models/nr_meas_rep_ue_notification_nr_neigh_cell_meas_info.proto
models/nr_meas_rep_ue_notification_s_cell.proto
models/nr_meas_rep_ue_notification_serv_cell_meas_info.proto
models/nr_meas_rep_ue_subscription.proto
models/nr_meas_rep_ue_subscription_filter_criteria_nr_mrs.proto
models/plmn.proto
models/plmn_info.proto
models/problem_details.proto
models/rab_est_notification.proto
models/rab_est_notification_erab_qos_parameters.proto
models/rab_est_notification_erab_qos_parameters_qos_information.proto
models/rab_est_notification_temp_ue_id.proto
models/rab_est_subscription.proto
models/rab_est_subscription_filter_criteria_qci.proto
models/rab_info.proto
models/rab_info_cell_user_info.proto
models/rab_info_erab_info.proto
models/rab_info_ue_info.proto
models/rab_mod_notification.proto
models/rab_mod_notification_erab_qos_parameters.proto
models/rab_mod_notification_erab_qos_parameters_qos_information.proto
models/rab_mod_subscription.proto
models/rab_mod_subscription_filter_criteria_qci.proto
models/rab_rel_notification.proto
models/rab_rel_notification_erab_release_info.proto
models/rab_rel_subscription.proto
models/results_per_csi_rs_index.proto
models/results_per_csi_rs_index_list.proto
models/results_per_csi_rs_index_list_results_per_csi_rs_index.proto
models/results_per_ssb_index.proto
models/results_per_ssb_index_list.proto
models/results_per_ssb_index_list_results_per_ssb_index.proto
models/rs_index_results.proto
models/s1_bearer_info.proto
models/s1_bearer_info_enb_info.proto
models/s1_bearer_info_s1_bearer_info_detailed.proto
models/s1_bearer_info_s1_ue_info.proto
models/s1_bearer_info_s_gw_info.proto
models/s1_bearer_notification.proto
models/s1_bearer_notification_s1_ue_info.proto
models/s1_bearer_subscription.proto
models/s1_bearer_subscription_s1_bearer_subscription_criteria.proto
models/subscription_link_list.proto
models/subscription_link_list_links.proto
models/subscription_link_list_links_subscription.proto
models/time_stamp.proto
models/trigger.proto
models/trigger_nr.proto
services/rni_service.proto
5.0.0-beta2
\ No newline at end of file
# gPRC for mec012
The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
## Overview
These files were generated by the [OpenAPI Generator](https://openapi-generator.tech) project.
- API version: 2.1.1
- Package version:
- Build package: org.openapitools.codegen.languages.ProtobufSchemaCodegen
For more information, please visit [https://forge.etsi.org/rep/mec/gs012-rnis-api](https://forge.etsi.org/rep/mec/gs012-rnis-api)
## Usage
Below are some usage examples for Go and Ruby. For other languages, please refer to https://grpc.io/docs/quickstart/.
### Go
```
# assuming `protoc-gen-go` has been installed with `go get -u github.com/golang/protobuf/protoc-gen-go`
mkdir /var/tmp/go/
protoc --go_out=/var/tmp/go/ services/*
protoc --go_out=/var/tmp/go/ models/*
```
### Ruby
```
# assuming `grpc_tools_ruby_protoc` has been installed via `gem install grpc-tools`
RUBY_OUTPUT_DIR="/var/tmp/ruby/mec012"
mkdir $RUBY_OUTPUT_DIR
grpc_tools_ruby_protoc --ruby_out=$RUBY_OUTPUT_DIR --grpc_out=$RUBY_OUTPUT_DIR/lib services/*
grpc_tools_ruby_protoc --ruby_out=$RUBY_OUTPUT_DIR --grpc_out=$RUBY_OUTPUT_DIR/lib models/*
```
/*
ETSI GS MEC 012 - Radio Network Information API
The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
The version of the OpenAPI document: 2.1.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec012;
message AssociateId {
// Numeric value (0-255) corresponding to specified type of identifier as following: <p>0 = reserved. <p>1 = UE_IPv4_ADDRESS. <p>2 = UE_IPV6_ADDRESS. <p>3 = NATED_IP_ADDRESS. <p>4 = GTP_TEID.
enum TypeEnum {
_0 = 0;
_1 = 1;
_2 = 2;
_3 = 3;
_4 = 4;
}
TypeEnum type = 1;
// Value for the identifier.
string value = 2;
}
/*
ETSI GS MEC 012 - Radio Network Information API
The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
The version of the OpenAPI document: 2.1.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec012;
import public "models/associate_id.proto";
import public "models/ca_reconf_notification_carrier_aggregation_meas_info.proto";
import public "models/ca_reconf_notification_secondary_cell_add.proto";
import public "models/ecgi.proto";
import public "models/time_stamp.proto";
message CaReconfNotification {
// 0 to N identifiers to associate the event for a specific UE or flow.
repeated AssociateId associateId = 1;
// This parameter can be repeated to contain information of all the carriers assign for Carrier Aggregation up to M.
repeated CaReconfNotificationCarrierAggregationMeasInfo carrierAggregationMeasInfo = 2;
Ecgi ecgi = 3;
// Shall be set to \"CaReConfNotification\".
string notificationType = 4;
repeated CaReconfNotificationSecondaryCellAdd secondaryCellAdd = 5;
repeated CaReconfNotificationSecondaryCellAdd secondaryCellRemove = 6;
TimeStamp timeStamp = 7;
}
/*
ETSI GS MEC 012 - Radio Network Information API
The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
The version of the OpenAPI document: 2.1.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec012;
message CaReconfNotificationCarrierAggregationMeasInfo {
// String representing the E-UTRAN Cell Identity. Encoded as a bit string (size (28)) as defined in ETSI TS 136 413 [i.3].
string cellIdNei = 1;
// String representing the E-UTRAN Cell Identity. Encoded as a bit string (size (28)) as defined in ETSI TS 136 413 [i.3].
string cellIdSrv = 2;
// Reference Signal Received Power as defined in ETSI TS 136 214 [i.5].
int32 rsrpNei = 3;
// Reference Signal Received Power as defined in ETSI TS 136 214 [i.5].
int32 rsrpSrv = 4;
// Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].
int32 rsrqNei = 5;
// Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].
int32 rsrqSrv = 6;
}
/*
ETSI GS MEC 012 - Radio Network Information API
The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
The version of the OpenAPI document: 2.1.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec012;
import public "models/ecgi.proto";
message CaReconfNotificationSecondaryCellAdd {
Ecgi ecgi = 1;
}
/*
ETSI GS MEC 012 - Radio Network Information API
The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
The version of the OpenAPI document: 2.1.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec012;
import public "models/ca_reconf_subscription_filter_criteria_assoc.proto";
import public "models/ca_reconf_subscription_links.proto";
import public "models/time_stamp.proto";
message CaReconfSubscription {
CaReconfSubscriptionLinks Underscorelinks = 1;
// URI selected by the service consumer to receive notifications on the subscribed RNIS information. This shall be included both in the request and in response.
string callbackReference = 2;
TimeStamp expiryDeadline = 3;
CaReconfSubscriptionFilterCriteriaAssoc filterCriteriaAssoc = 4;
// Shall be set to \"CaReconfSubscription\".
string subscriptionType = 5;
}
/*
ETSI GS MEC 012 - Radio Network Information API
The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
The version of the OpenAPI document: 2.1.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec012;
import public "models/associate_id.proto";
import public "models/ecgi.proto";
message CaReconfSubscriptionFilterCriteriaAssoc {
// Unique identifier for the MEC application instance.
string appInstanceId = 1;
// 0 to N identifiers to associate the information for a specific UE or flow.
repeated AssociateId associateId = 2;
// E-UTRAN Cell Global Identifier.
repeated Ecgi ecgi = 3;
}
/*
ETSI GS MEC 012 - Radio Network Information API
The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
The version of the OpenAPI document: 2.1.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec012;
import public "models/link_type.proto";
message CaReconfSubscriptionLinks {
LinkType self = 1;
}
/*
ETSI GS MEC 012 - Radio Network Information API
The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
The version of the OpenAPI document: 2.1.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec012;
import public "models/associate_id.proto";
import public "models/cell_change_notification_temp_ue_id.proto";
import public "models/ecgi.proto";
import public "models/time_stamp.proto";
message CellChangeNotification {
// 0 to N identifiers to associate the event for a specific UE or flow.
repeated AssociateId associateId = 1;
// Indicate the status of the UE handover procedure. Values are defined as following: <p>1 = IN_PREPARATION. <p>2 = IN_EXECUTION. <p>3 = COMPLETED. <p>4 = REJECTED. <p>5 = CANCELLED.
enum HoStatusEnum {
_1 = 0;
_2 = 1;
_3 = 2;
_4 = 3;
_5 = 4;
}
HoStatusEnum hoStatus = 2;
// Shall be set to \"CellChangeNotification\".
string notificationType = 3;
Ecgi srcEcgi = 4;
CellChangeNotificationTempUeId tempUeId = 5;
TimeStamp timeStamp = 6;
// E-UTRAN Cell Global Identifier of the target cell. NOTE: Cardinality N is valid only in case of statuses IN_PREPARATION, REJECTED and CANCELLED.
repeated Ecgi trgEcgi = 7;
}
/*
ETSI GS MEC 012 - Radio Network Information API
The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
The version of the OpenAPI document: 2.1.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec012;
message CellChangeNotificationTempUeId {
// MMEC as defined in ETSI TS 136 413 [i.3].
string mmec = 1;
// M-TMSI as defined in ETSI TS 136 413 [i.3].
string mtmsi = 2;
}
/*
ETSI GS MEC 012 - Radio Network Information API
The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
The version of the OpenAPI document: 2.1.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec012;
import public "models/ca_reconf_subscription_links.proto";
import public "models/cell_change_subscription_filter_criteria_assoc_ho.proto";
import public "models/time_stamp.proto";
message CellChangeSubscription {
CaReconfSubscriptionLinks Underscorelinks = 1;
// URI selected by the service consumerto receive notifications on the subscribed RNIS information. This shall be included both in the request and in response.
string callbackReference = 2;
TimeStamp expiryDeadline = 3;
CellChangeSubscriptionFilterCriteriaAssocHo filterCriteriaAssocHo = 4;
// Shall be set to \"CellChangeSubscription\".
string subscriptionType = 5;
}
/*
ETSI GS MEC 012 - Radio Network Information API
The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
The version of the OpenAPI document: 2.1.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec012;
import public "models/associate_id.proto";
import public "models/ecgi.proto";
message CellChangeSubscriptionFilterCriteriaAssocHo {
// Unique identifier for the MEC application instance.
string appInstanceId = 1;
// 0 to N identifiers to associate the information for a specific UE or flow.
repeated AssociateId associateId = 2;
// E-UTRAN Cell Global Identifier.
repeated Ecgi ecgi = 3;
// In case hoStatus is not included in the subscription request, the default value 3 = COMPLETED shall be used and included in the response: <p>1 = IN_PREPARATION. <p>2 = IN_EXECUTION. <p>3 = COMPLETED. <p>4 = REJECTED. <p>5 = CANCELLED.
repeated int32 hoStatus = 4;
}
/*
ETSI GS MEC 012 - Radio Network Information API
The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
The version of the OpenAPI document: 2.1.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec012;
import public "models/plmn.proto";
message Ecgi {
// String representing the E-UTRAN Cell Identity. Encoded as a bit string (size (28)) as defined in ETSI TS 136 413 [i.3].
string cellId = 1;
Plmn plmn = 2;
}
/*
ETSI GS MEC 012 - Radio Network Information API
The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
The version of the OpenAPI document: 2.1.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec012;
import public "models/expiry_notification_links.proto";
import public "models/time_stamp.proto";
message ExpiryNotification {
ExpiryNotificationLinks Underscorelinks = 1;
TimeStamp expiryDeadline = 2;
TimeStamp timeStamp = 3;
}
/*
ETSI GS MEC 012 - Radio Network Information API
The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
The version of the OpenAPI document: 2.1.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec012;
message ExpiryNotificationLinks {
// Self referring URI. This shall be included in the response from the RNIS. The URI shall be unique within the RNI API as it acts as an ID for the subscription.
string self = 1;
}
/*
ETSI GS MEC 012 - Radio Network Information API
The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
The version of the OpenAPI document: 2.1.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec012;
import public "models/cell_change_notification.proto";
import public "models/rab_est_notification.proto";
import public "models/rab_mod_notification.proto";
import public "models/rab_rel_notification.proto";
import public "models/meas_rep_ue_notification.proto";
import public "models/nr_meas_rep_ue_notification.proto";
import public "models/meas_ta_notification.proto";
import public "models/ca_reconf_notification.proto";
import public "models/s1_bearer_notification.proto";
message InlineNotification {
oneof notification {
CellChangeNotification cellChangeNotification = 1;
RabEstNotification rabEstNotification = 2;
RabModNotification RabModNotification = 3;
RabRelNotification RabRelNotification = 4;
MeasRepUeNotification MeasRepUeNotification = 5;
NrMeasRepUeNotification NrMeasRepUeNotification = 6;
MeasTaNotification MeasTaNotification = 7;
CaReconfNotification CaReconfNotification = 8;
S1BearerNotification S1BearerNotification = 9;
}
}
/*
ETSI GS MEC 012 - Radio Network Information API
The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
The version of the OpenAPI document: 2.1.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec012;
import public "models/cell_change_subscription.proto";
import public "models/rab_est_subscription.proto";
import public "models/rab_mod_subscription.proto";
import public "models/rab_rel_subscription.proto";
import public "models/meas_rep_ue_subscription.proto";
import public "models/meas_ta_subscription.proto";
import public "models/ca_reconf_subscription.proto";
import public "models/s1_bearer_subscription.proto";
import public "models/nr_meas_rep_ue_subscription.proto";
message InlineSubscription {
oneof subscription {
CellChangeSubscription cellChangeSubscription = 1;
RabEstSubscription rabEstSubscription = 2;